software.amazon.awscdk.services.ecr.assets

Class DockerImageAsset

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.ecr.assets.DockerImageAsset

All Implemented Interfaces:

IAsset, IConstruct, IDependable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.919Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockerImageAsset.Builder A fluent builder for DockerImageAsset.

Nested classes/interfaces inherited from interface software.amazon.awscdk.assets.IAsset

IAsset.Jsii$Default, IAsset.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DockerImageAsset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DockerImageAsset(software.amazon.jsii.JsiiObjectRef objRef)
	DockerImageAsset(software.constructs.Construct scope, java.lang.String id, DockerImageAssetProps props)

Method Summary

Modifier and Type	Method and Description
void	addResourceMetadata(CfnResource resource, java.lang.String resourceProperty) Adds CloudFormation template metadata to the specified resource with information that indicates which resource property is mapped to this local asset.
java.lang.String	getAssetHash() A hash of this asset, which is available at construction time.
java.lang.String	getImageUri() The full URI of the image (including a tag).
IRepository	getRepository() Repository where the image is stored.
java.lang.String	getSourceHash() Deprecated. use assetHash
void	setImageUri(java.lang.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.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DockerImageAsset

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

DockerImageAsset

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

DockerImageAsset

public DockerImageAsset(software.constructs.Construct scope,
                        java.lang.String id,
                        DockerImageAssetProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

addResourceMetadata

public void addResourceMetadata(CfnResource resource,
                                java.lang.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:

https://github.com/aws/aws-cdk/issues/1432

getAssetHash

public java.lang.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

@Deprecated
public java.lang.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

public java.lang.String getImageUri()

The full URI of the image (including a tag).

Use this reference to pull the asset.

setImageUri

public void setImageUri(java.lang.String value)

The full URI of the image (including a tag).

Use this reference to pull the asset.

getRepository

public IRepository getRepository()

Repository where the image is stored.

setRepository

public void setRepository(IRepository value)

Repository where the image is stored.