Package software.amazon.awscdk.services.ecr.assets

Class DockerImageAsset

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.services.ecr.assets.DockerImageAsset
All Implemented Interfaces:
IAsset, IConstruct, IDependable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.982Z") @Stability(Stable) public class DockerImageAsset extends Construct implements IAsset
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;
 import software.amazon.awscdk.services.ecr.assets.NetworkMode;
 DockerImageAsset asset = DockerImageAsset.Builder.create(this, "MyBuildImage")
         .directory(join(__dirname, "my-image"))
         .networkMode(NetworkMode.HOST)
         .build();

  • 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

      @Stability(Stable) @NotNull public String 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.

    • getSourceHash

      @Stability(Deprecated) @Deprecated @NotNull public String getSourceHash()
      Deprecated.
      use assetHash
      (deprecated) A hash of the source 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.

      Specified by:
      getSourceHash in interface IAsset

    • getImageUri

      @Stability(Stable) @NotNull public String getImageUri()
      The full URI of the image (including a tag).

      Use this reference to pull the asset.

    • setImageUri

      @Stability(Stable) public void setImageUri(@NotNull String value)
      The full URI of the image (including a tag).

      Use this reference to pull the asset.

    • getRepository

      @Stability(Stable) @NotNull public IRepository getRepository()
      Repository where the image is stored.

    • setRepository

      @Stability(Stable) public void setRepository(@NotNull IRepository value)
      Repository where the image is stored.