software.amazon.awscdk.services.ecr.assets

Class TarballImageAsset

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.ecr.assets.TarballImageAsset

All Implemented Interfaces:

IAsset, IConstruct, IDependable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.940Z")
public class TarballImageAsset
extends Construct
implements IAsset

An asset that represents a Docker image.

The image will loaded from an existing tarball and uploaded to an ECR repository.

Example:

 import software.amazon.awscdk.services.ecr.assets.TarballImageAsset;
 TarballImageAsset asset = TarballImageAsset.Builder.create(this, "MyBuildImage")
         .tarballFile("local-image.tar")
         .build();
 

Nested Class Summary

Nested Classes

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

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	TarballImageAsset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TarballImageAsset(software.amazon.jsii.JsiiObjectRef objRef)
	TarballImageAsset(software.constructs.Construct scope, java.lang.String id, TarballImageAssetProps props)

Method Summary

Modifier and Type	Method and Description
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

TarballImageAsset

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

TarballImageAsset

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

TarballImageAsset

public TarballImageAsset(software.constructs.Construct scope,
                         java.lang.String id,
                         TarballImageAssetProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

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.