@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
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();
Modifier | Constructor and Description |
---|---|
protected |
ContainerImage() |
protected |
ContainerImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
ContainerImage(software.amazon.jsii.JsiiObjectRef objRef) |
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.
|
protected ContainerImage(software.amazon.jsii.JsiiObjectRef objRef)
protected ContainerImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected ContainerImage()
public static AssetImage fromAsset(java.lang.String directory, AssetImageProps props)
If you already have a DockerImageAsset
instance, you can use the
ContainerImage.fromDockerImageAsset
method instead.
directory
- The directory containing the Dockerfile. This parameter is required.props
- public static AssetImage fromAsset(java.lang.String directory)
If you already have a DockerImageAsset
instance, you can use the
ContainerImage.fromDockerImageAsset
method instead.
directory
- The directory containing the Dockerfile. This parameter is required.public static ContainerImage fromDockerImageAsset(DockerImageAsset asset)
asset
- The `DockerImageAsset` to use for this container definition. This parameter is required.public static EcrImage fromEcrRepository(IRepository repository, java.lang.String tag)
repository
- This parameter is required.tag
- public static EcrImage fromEcrRepository(IRepository repository)
repository
- This parameter is required.public static RepositoryImage fromRegistry(java.lang.String name, RepositoryImageProps props)
name
- This parameter is required.props
- public static RepositoryImage fromRegistry(java.lang.String name)
name
- This parameter is required.public static ContainerImage fromTarball(java.lang.String tarballFile)
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.
tarballFile
- Absolute path to the tarball. This parameter is required.public abstract ContainerImageConfig bind(Construct scope, ContainerDefinition containerDefinition)
scope
- This parameter is required.containerDefinition
- This parameter is required.