aws-cdk-lib.aws_ecr_assets.TarballImageAsset

class TarballImageAsset (construct)

LanguageType name
.NETAmazon.CDK.AWS.Ecr.Assets.TarballImageAsset
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsecrassets#TarballImageAsset
Javasoftware.amazon.awscdk.services.ecr.assets.TarballImageAsset
Pythonaws_cdk.aws_ecr_assets.TarballImageAsset
TypeScript (source)aws-cdk-lib » aws_ecr_assets » TarballImageAsset

Implements IConstruct, IDependable

An asset that represents a Docker image.

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

Example

import { TarballImageAsset } from 'aws-cdk-lib/aws-ecr-assets';

const asset = new TarballImageAsset(this, 'MyBuildImage', {
  tarballFile: 'local-image.tar',
});

Initializer

new TarballImageAsset(scope: Construct, id: string, props: TarballImageAssetProps)

Parameters

  • scope Construct
  • id string
  • props TarballImageAssetProps

Construct Props

NameTypeDescription
tarballFilestringAbsolute path to the tarball.

tarballFile

Type: string

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.

Properties

NameTypeDescription
assetHashstringA hash of this asset, which is available at construction time.
imageTagstringThe tag of this asset when it is uploaded to ECR.
imageUristringThe full URI of the image (including a tag).
nodeNodeThe tree node.
repositoryIRepositoryRepository where the image is stored.

assetHash

Type: string

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.


imageTag

Type: string

The tag of this asset when it is uploaded to ECR.

The tag may differ from the assetHash if a stack synthesizer adds a dockerTagPrefix.


imageUri

Type: string

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

Use this reference to pull the asset.


node

Type: Node

The tree node.


repository

Type: IRepository

Repository where the image is stored.

Methods

NameDescription
toString()Returns a string representation of this construct.

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.