software.amazon.awscdk.services.ecs

Class EcrImage

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.ContainerImage

software.amazon.awscdk.services.ecs.EcrImage

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.695Z")
 @Stability(value=Stable)
public class EcrImage
extends ContainerImage

An image from an Amazon ECR repository.

Example:

 Secret dbSecret = new Secret(this, "secret");
 JobDefinition.Builder.create(this, "batch-job-def-secrets")
         .container(JobDefinitionContainer.builder()
                 .image(EcrImage.fromRegistry("docker/whalesay"))
                 .secrets(Map.of(
                         "PASSWORD", Secret.fromSecretsManager(dbSecret, "password")))
                 .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
	EcrImage(IRepository repository, String tagOrDigest) Constructs a new instance of the EcrImage class.
protected	EcrImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	EcrImage(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
ContainerImageConfig	bind(software.constructs.Construct _scope, ContainerDefinition containerDefinition) Called when the image is used by a ContainerDefinition.
String	getImageName() The image name.

Methods inherited from class software.amazon.awscdk.services.ecs.ContainerImage

fromAsset, fromAsset, fromDockerImageAsset, fromEcrRepository, fromEcrRepository, fromRegistry, fromRegistry, fromTarball

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

EcrImage

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

EcrImage

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

EcrImage

@Stability(value=Stable)
public EcrImage(@NotNull
                                         IRepository repository,
                                         @NotNull
                                         String tagOrDigest)

Constructs a new instance of the EcrImage class.

Parameters:

repository - This parameter is required.

tagOrDigest - This parameter is required.

Method Detail

bind

@Stability(value=Stable)
 @NotNull
public ContainerImageConfig bind(@NotNull
                                                                    software.constructs.Construct _scope,
                                                                    @NotNull
                                                                    ContainerDefinition containerDefinition)

Called when the image is used by a ContainerDefinition.

Specified by:

bind in class ContainerImage

Parameters:

_scope - This parameter is required.

containerDefinition - This parameter is required.

getImageName

@Stability(value=Stable)
 @NotNull
public String getImageName()

The image name. Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest.

For example, 012345678910.dkr.ecr..amazonaws.com/:latest or 012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.