@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:41.919Z") public class DockerImageAsset extends Construct implements IAsset
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();
Modifier and Type | Class and Description |
---|---|
static class |
DockerImageAsset.Builder
A fluent builder for
DockerImageAsset . |
IAsset.Jsii$Default, IAsset.Jsii$Proxy
IConstruct.Jsii$Default, IConstruct.Jsii$Proxy
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) |
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.
|
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
protected DockerImageAsset(software.amazon.jsii.JsiiObjectRef objRef)
protected DockerImageAsset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public DockerImageAsset(software.constructs.Construct scope, java.lang.String id, DockerImageAssetProps props)
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.public void addResourceMetadata(CfnResource resource, java.lang.String resourceProperty)
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.
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.public java.lang.String getAssetHash()
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.
@Deprecated public java.lang.String getSourceHash()
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
in interface IAsset
public java.lang.String getImageUri()
Use this reference to pull the asset.
public void setImageUri(java.lang.String value)
Use this reference to pull the asset.
public IRepository getRepository()
public void setRepository(IRepository value)