An asset that represents a Docker image.

The image will be created in build time and uploaded to an ECR repository.

Adds CloudFormation template metadata to the specified resource with information that indicates which resource property is mapped to this local asset.

This can be used by tools such as SAM CLI to provide local
experience such as local invocation and debugging of Lambda functions.

Asset metadata will only be included if the stack is synthesized with the
"aws:cdk:enable-asset-metadata" context key defined, which is the default
behavior when synthesizing via the CDK Toolkit.

addResourceMetadata

DockerImageAsset

The directory where the Dockerfile is stored.

Any directory inside with a name that matches the CDK output folder (cdk.out by default) will be excluded from the asset

assetName

Build args to pass to the `docker build` command.

Since Docker build arguments are resolved before deployment, keys and
values cannot refer to unresolved tokens (such as `lambda.functionArn` or
`queue.queueUrl`).

buildArgs

Build contexts to pass to the `docker build` command.

Build contexts can be used to specify additional directories or images
to use during the build. Each entry specifies a named build context
and its source (a directory path, a URL, or a docker image).

Since Docker build contexts are resolved before deployment, keys and
values cannot refer to unresolved tokens (such as `lambda.functionArn` or
`queue.queueUrl`).

buildContexts

Build secrets.

Docker BuildKit must be enabled to use build secrets.

buildSecrets

SSH agent socket or keys to pass to the `docker build` command.

Docker BuildKit must be enabled to use the ssh flag

buildSsh

Disable the cache and pass `--no-cache` to the `docker build` command.

cacheDisabled

Cache from options to pass to the `docker build` command.

cacheFrom

Cache to options to pass to the `docker build` command.

cacheTo

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.

If `assetName` is given, it will also be used as the default `displayName`.
Otherwise, the default is the construct path of the ImageAsset 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.

displayName

Path to the Dockerfile (relative to the directory).

file

Options to control which parameters are used to invalidate the asset hash.

invalidation

Networking mode for the RUN commands during build.

Support docker API 1.25+.

networkMode

Outputs to pass to the `docker build` command.

outputs

Platform to build for.

_Requires Docker Buildx_.

platform

target

Extra information to encode into the fingerprint (e.g. build instructions and other inputs).

extraHash

File paths matching the patterns will be excluded.

See `ignoreMode` to set the matching behavior.
Has no effect on Assets bundled using the `bundling` property.

exclude

followSymlinks

The ignore behavior to use for `exclude` patterns.

ignoreMode

An asset that represents a Docker image.

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

TarballImageAsset

Absolute path to the tarball.

It is recommended 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.

tarballFile

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.

AWS ecr Assets

L2 Constructs2

DockerImageAsset

TarballImageAsset

Learn AWS the Practical Way

Quick Facts

Related Links