software.amazon.awscdk.services.ecs

Class TagParameterContainerImage

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.ContainerImage

software.amazon.awscdk.services.ecs.TagParameterContainerImage

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:17.264Z")
 @Stability(value=Experimental)
public class TagParameterContainerImage
extends ContainerImage

(experimental) A special type of ContainerImage that uses an ECR repository for the image, but a CloudFormation Parameter for the tag of the image in that repository.

This allows providing this tag through the Parameter at deploy time, for example in a CodePipeline that pushes a new tag of the image to the repository during a build step, and then provides that new tag through the CloudFormation Parameter in the deploy step.

See Also:

#tagParameterName

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
	TagParameterContainerImage(IRepository repository)
protected	TagParameterContainerImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TagParameterContainerImage(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
ContainerImageConfig	bind(software.constructs.Construct scope, ContainerDefinition containerDefinition) (experimental) Called when the image is used by a ContainerDefinition.
String	getTagParameterName() (experimental) Returns the name of the CloudFormation Parameter that represents the tag of the image in the ECR repository.
String	getTagParameterValue() (experimental) Returns the value of the CloudFormation Parameter that represents the tag of the image in the ECR repository.

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

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

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

TagParameterContainerImage

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

TagParameterContainerImage

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

TagParameterContainerImage

@Stability(value=Experimental)
public TagParameterContainerImage(@NotNull
                                                                 IRepository repository)

Parameters:

repository - This parameter is required.

Method Detail

bind

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

(experimental) 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.

getTagParameterName

@Stability(value=Experimental)
 @NotNull
public String getTagParameterName()

(experimental) Returns the name of the CloudFormation Parameter that represents the tag of the image in the ECR repository.

getTagParameterValue

@Stability(value=Experimental)
 @NotNull
public String getTagParameterValue()

(experimental) Returns the value of the CloudFormation Parameter that represents the tag of the image in the ECR repository.