TarballImageAsset
- class aws_cdk.aws_ecr_assets.TarballImageAsset(scope, id, *, tarball_file)
Bases:
Construct
An asset that represents a Docker image.
The image will loaded from an existing tarball and uploaded to an ECR repository.
- ExampleMetadata:
infused
Example:
from aws_cdk.aws_ecr_assets import TarballImageAsset asset = TarballImageAsset(self, "MyBuildImage", tarball_file="local-image.tar" )
- Parameters:
scope (
Construct
) –id (
str
) –tarball_file (
str
) – 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.
Methods
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- asset_hash
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.
- image_tag
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.
- image_uri
The full URI of the image (including a tag).
Use this reference to pull the asset.
- node
The tree node.
- repository
Repository where the image is stored.
Static Methods
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.