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

Interface TarballImageAssetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TarballImageAssetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:03.660Z")
@Stability(Stable)
public interface TarballImageAssetProps
extends software.amazon.jsii.JsiiSerializable

Options for TarballImageAsset.

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	Interface	Description
static final class	TarballImageAssetProps.Builder	A builder for TarballImageAssetProps
static final class	TarballImageAssetProps.Jsii$Proxy	An implementation for TarballImageAssetProps

Method Summary

Modifier and Type	Method	Description
static TarballImageAssetProps.Builder	builder()
default String	getDisplayName()	A display name for this asset.
String	getTarballFile()	Absolute path to the tarball.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTarballFile

@Stability(Stable)
@NotNull
String getTarballFile()

Absolute path to the tarball.

It is recommended to to use the script running directory (e.g. __dirname in Node.js projects or dirname of __file__ in Python) if your tarball is located as a resource inside your project.

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

A display name for this asset.

If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used.

The default is the construct path of the TarballImageAsset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as lambda.Code.fromAssetImage()), this will look like MyFunction/AssetImage.

We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like /MyBetaStack/MyFunction/Code when you are actually deploying to production.

Default: - Stack-relative construct path

builder

@Stability(Stable)
static TarballImageAssetProps.Builder builder()

Returns:

a TarballImageAssetProps.Builder of TarballImageAssetProps