software.amazon.awscdk.services.ecs

Class ContainerImage

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.ContainerImage

Direct Known Subclasses:

AssetImage, EcrImage, RepositoryImage, TagParameterContainerImage

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:37:00.306Z")
public abstract class ContainerImage
extends software.amazon.jsii.JsiiObject

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();
 

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) Called when the image is used by a ContainerDefinition.
static AssetImage	fromAsset(java.lang.String directory) Reference an image that's constructed directly from sources on disk.
static AssetImage	fromAsset(java.lang.String directory, AssetImageProps props) Reference an image that's constructed directly from sources on disk.
static ContainerImage	fromDockerImageAsset(DockerImageAsset asset) Use an existing `DockerImageAsset` for this container image.
static EcrImage	fromEcrRepository(IRepository repository) Reference an image in an ECR repository.
static EcrImage	fromEcrRepository(IRepository repository, java.lang.String tag) Reference an image in an ECR repository.
static RepositoryImage	fromRegistry(java.lang.String name) Reference an image on DockerHub or another online registry.
static RepositoryImage	fromRegistry(java.lang.String name, RepositoryImageProps props) Reference an image on DockerHub or another online registry.
static ContainerImage	fromTarball(java.lang.String tarballFile) Use an existing tarball for this container image.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerImage

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

ContainerImage

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

ContainerImage

protected ContainerImage()

Method Detail

fromAsset

public static AssetImage fromAsset(java.lang.String directory,
                                   AssetImageProps props)

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

public static AssetImage fromAsset(java.lang.String directory)

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

public static ContainerImage fromDockerImageAsset(DockerImageAsset asset)

Use an existing `DockerImageAsset` for this container image.

Parameters:

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

fromEcrRepository

public static EcrImage fromEcrRepository(IRepository repository,
                                         java.lang.String tag)

Reference an image in an ECR repository.

Parameters:

repository - This parameter is required.

tag -

fromEcrRepository

public static EcrImage fromEcrRepository(IRepository repository)

Reference an image in an ECR repository.

Parameters:

repository - This parameter is required.

fromRegistry

public static RepositoryImage fromRegistry(java.lang.String name,
                                           RepositoryImageProps props)

Reference an image on DockerHub or another online registry.

Parameters:

name - This parameter is required.

props -

fromRegistry

public static RepositoryImage fromRegistry(java.lang.String name)

Reference an image on DockerHub or another online registry.

Parameters:

name - This parameter is required.

fromTarball

public static ContainerImage fromTarball(java.lang.String tarballFile)

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

public abstract ContainerImageConfig bind(Construct scope,
                                          ContainerDefinition containerDefinition)

Called when the image is used by a ContainerDefinition.

Parameters:

scope - This parameter is required.

containerDefinition - This parameter is required.