class TarballImageAsset (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Ecr.Assets.TarballImageAsset |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsecrassets#TarballImageAsset |
![]() | software.amazon.awscdk.services.ecr.assets.TarballImageAsset |
![]() | aws_cdk.aws_ecr_assets.TarballImageAsset |
![]() | 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
Tarball
Image Asset Props
Construct Props
Name | Type | Description |
---|---|---|
tarball | string | Absolute 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
Name | Type | Description |
---|---|---|
asset | string | A hash of this asset, which is available at construction time. |
image | string | The tag of this asset when it is uploaded to ECR. |
image | string | The full URI of the image (including a tag). |
node | Node | The tree node. |
repository | IRepository | Repository 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
Name | Description |
---|---|
to | Returns a string representation of this construct. |
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.