software.amazon.awscdk.services.ecs

Class ContainerImage

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.ContainerImage

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

AssetImage, EcrImage, RepositoryImage, TagParameterContainerImage

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:47.483Z")
 @Stability(value=Experimental)
public abstract class ContainerImage
extends software.amazon.jsii.JsiiObject

(experimental) Constructs for types of container images.

Example:

 Vpc vpc;
 Cluster cluster = Cluster.Builder.create(this, "FargateCPCluster")
         .vpc(vpc)
         .enableFargateCapacityProviders(true)
         .build();
 FargateTaskDefinition taskDefinition = new FargateTaskDefinition(this, "TaskDef");
 taskDefinition.addContainer("web", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
         .build());
 FargateService.Builder.create(this, "FargateService")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .capacityProviderStrategies(List.of(CapacityProviderStrategy.builder()
                 .capacityProvider("FARGATE_SPOT")
                 .weight(2)
                 .build(), CapacityProviderStrategy.builder()
                 .capacityProvider("FARGATE")
                 .weight(1)
                 .build()))
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContainerImage()
protected	ContainerImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ContainerImage(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
abstract ContainerImageConfig	bind(Construct scope, ContainerDefinition containerDefinition) (experimental) Called when the image is used by a ContainerDefinition.
static AssetImage	fromAsset(String directory) (experimental) Reference an image that's constructed directly from sources on disk.
static AssetImage	fromAsset(String directory, AssetImageProps props) (experimental) Reference an image that's constructed directly from sources on disk.
static ContainerImage	fromDockerImageAsset(DockerImageAsset asset) (experimental) Use an existing `DockerImageAsset` for this container image.
static EcrImage	fromEcrRepository(IRepository repository) (experimental) Reference an image in an ECR repository.
static EcrImage	fromEcrRepository(IRepository repository, String tag) (experimental) Reference an image in an ECR repository.
static RepositoryImage	fromRegistry(String name) (experimental) Reference an image on DockerHub or another online registry.
static RepositoryImage	fromRegistry(String name, RepositoryImageProps props) (experimental) Reference an image on DockerHub or another online registry.
static ContainerImage	fromTarball(String tarballFile) (experimental) Use an existing tarball for this container image.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ContainerImage

protected ContainerImage(software.amazon.jsii.JsiiObjectRef objRef)

ContainerImage

protected ContainerImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ContainerImage

@Stability(value=Experimental)
protected ContainerImage()

Method Detail

fromAsset

@Stability(value=Experimental)
 @NotNull
public static AssetImage fromAsset(@NotNull
                                                                            String directory,
                                                                            @Nullable
                                                                            AssetImageProps props)

(experimental) Reference an image that's constructed directly from sources on disk.

If you already have a DockerImageAsset instance, you can use the ContainerImage.fromDockerImageAsset method instead.

Parameters:

directory - The directory containing the Dockerfile. This parameter is required.

props -

fromAsset

@Stability(value=Experimental)
 @NotNull
public static AssetImage fromAsset(@NotNull
                                                                            String directory)

(experimental) Reference an image that's constructed directly from sources on disk.

If you already have a DockerImageAsset instance, you can use the ContainerImage.fromDockerImageAsset method instead.

Parameters:

directory - The directory containing the Dockerfile. This parameter is required.

fromDockerImageAsset

@Stability(value=Experimental)
 @NotNull
public static ContainerImage fromDockerImageAsset(@NotNull
                                                                                           DockerImageAsset asset)

(experimental) Use an existing `DockerImageAsset` for this container image.

Parameters:

asset - The `DockerImageAsset` to use for this container definition. This parameter is required.

fromEcrRepository

@Stability(value=Experimental)
 @NotNull
public static EcrImage fromEcrRepository(@NotNull
                                                                                  IRepository repository,
                                                                                  @Nullable
                                                                                  String tag)

(experimental) Reference an image in an ECR repository.

Parameters:

repository - This parameter is required.

tag -

fromEcrRepository

@Stability(value=Experimental)
 @NotNull
public static EcrImage fromEcrRepository(@NotNull
                                                                                  IRepository repository)

(experimental) Reference an image in an ECR repository.

Parameters:

repository - This parameter is required.

fromRegistry

@Stability(value=Experimental)
 @NotNull
public static RepositoryImage fromRegistry(@NotNull
                                                                                    String name,
                                                                                    @Nullable
                                                                                    RepositoryImageProps props)

(experimental) Reference an image on DockerHub or another online registry.

Parameters:

name - This parameter is required.

props -

fromRegistry

@Stability(value=Experimental)
 @NotNull
public static RepositoryImage fromRegistry(@NotNull
                                                                                    String name)

(experimental) Reference an image on DockerHub or another online registry.

Parameters:

name - This parameter is required.

fromTarball

@Stability(value=Experimental)
 @NotNull
public static ContainerImage fromTarball(@NotNull
                                                                                  String tarballFile)

(experimental) Use an existing tarball for this container image.

Use this method if the container image has already been created by another process (e.g. jib) and you want to add it as a container image asset.

Parameters:

tarballFile - Absolute path to the tarball. This parameter is required.

bind

@Stability(value=Experimental)
 @NotNull
public abstract ContainerImageConfig bind(@NotNull
                                                                                   Construct scope,
                                                                                   @NotNull
                                                                                   ContainerDefinition containerDefinition)

(experimental) Called when the image is used by a ContainerDefinition.

Parameters:

scope - This parameter is required.

containerDefinition - This parameter is required.