Class DockerImageAsset
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.services.ecr.assets.DockerImageAsset
- All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-04T00:39:31.473Z")
@Stability(Stable)
public class DockerImageAsset
extends software.constructs.Construct
An asset that represents a Docker image.
The image will be created in build time and uploaded to an ECR repository.
Example:
import software.amazon.awscdk.services.ecr.assets.DockerImageAsset; DockerImageAsset asset = DockerImageAsset.Builder.create(this, "MyBuildImage") .directory(join(__dirname, "my-image")) .buildArgs(Map.of( "HTTP_PROXY", "http://10.20.30.2:1234")) .invalidation(DockerImageAssetInvalidationOptions.builder() .buildArgs(false) .build()) .build();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
DockerImageAsset
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
DockerImageAsset
(software.amazon.jsii.JsiiObjectRef objRef) DockerImageAsset
(software.constructs.Construct scope, String id, DockerImageAssetProps props) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addResourceMetadata
(CfnResource resource, String resourceProperty) Adds CloudFormation template metadata to the specified resource with information that indicates which resource property is mapped to this local asset.A hash of this asset, which is available at construction time.The tag of this asset when it is uploaded to ECR.The full URI of the image (including a tag).Repository where the image is stored.void
setImageUri
(String value) The full URI of the image (including a tag).void
setRepository
(IRepository value) Repository where the image is stored.Methods inherited from class software.constructs.Construct
getNode, isConstruct, toString
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, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
DockerImageAsset
protected DockerImageAsset(software.amazon.jsii.JsiiObjectRef objRef) -
DockerImageAsset
protected DockerImageAsset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
DockerImageAsset
@Stability(Stable) public DockerImageAsset(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull DockerImageAssetProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
addResourceMetadata
@Stability(Stable) public void addResourceMetadata(@NotNull CfnResource resource, @NotNull String resourceProperty) Adds CloudFormation template metadata to the specified resource with information that indicates which resource property is mapped to this local asset.This can be used by tools such as SAM CLI to provide local experience such as local invocation and debugging of Lambda functions.
Asset metadata will only be included if the stack is synthesized with the "aws:cdk:enable-asset-metadata" context key defined, which is the default behavior when synthesizing via the CDK Toolkit.
- Parameters:
resource
- The CloudFormation resource which is using this asset [disable-awslint:ref-via-interface]. This parameter is required.resourceProperty
- The property name where this asset is referenced. This parameter is required.- See Also:
-
getAssetHash
A hash of this asset, which is available at construction time.As this is a plain string, it can be used in construct IDs in order to enforce creation of a new resource when the content hash has changed.
-
getImageTag
The tag of this asset when it is uploaded to ECR.The tag may differ from the assetHash if a stack synthesizer adds a dockerTagPrefix.
-
getImageUri
The full URI of the image (including a tag).Use this reference to pull the asset.
-
setImageUri
The full URI of the image (including a tag).Use this reference to pull the asset.
-
getRepository
Repository where the image is stored. -
setRepository
Repository where the image is stored.
-