AWS CDK Reference

Appearance

v2.274.0

ContainerImageAssetMetadataEntry Struct ​

Metadata Entry spec for container images.

Source
node_modules/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/metadata-schema.d.ts
Type last changed
v2.245.0 · 27 Mar 2026

Example ​

ts
const entry = {
  packaging: 'container-image',
  repositoryName: 'repository-name',
  imageTag: 'tag',
}

Properties ​

buildArgsoptional{ [key: string]: string }build_argsoptionaltyping.Mapping[str, str]buildArgsoptionalMap<String, String>BuildArgsoptionalIDictionary<string, string>BuildArgsoptional*map[string]*string#
Build args to pass to the `docker build` command.

Default: no build args are passed

buildContextsoptional{ [key: string]: string }build_contextsoptionaltyping.Mapping[str, str]buildContextsoptionalMap<String, String>BuildContextsoptionalIDictionary<string, string>BuildContextsoptional*map[string]*string#
Build contexts to pass to the `docker build` command.

Default: no build contexts are passed

buildSecretsoptional{ [key: string]: string }build_secretsoptionaltyping.Mapping[str, str]buildSecretsoptionalMap<String, String>BuildSecretsoptionalIDictionary<string, string>BuildSecretsoptional*map[string]*string#
Build secrets to pass to the `docker build` command.

Default: no build secrets are passed

buildSshoptionalstringbuild_sshoptionalstrbuildSshoptionalStringBuildSshoptionalstringBuildSshoptional*string#
SSH agent socket or keys to pass to the `docker build` command.

Default: no ssh arg is passed

cacheDisabledoptionalbooleancache_disabledoptionalboolcacheDisabledoptionalBooleanCacheDisabledoptionalboolCacheDisabledoptional*bool#
Disable the cache and pass `--no-cache` to the `docker build` command.

Default: cache is used

cacheFromoptionalContainerImageAssetCacheOption[]cache_fromoptionaltyping.List[ContainerImageAssetCacheOption]cacheFromoptionalList<ContainerImageAssetCacheOption>CacheFromoptionalContainerImageAssetCacheOption[]CacheFromoptional*[]ContainerImageAssetCacheOption#
Cache from options to pass to the `docker build` command.

Default: no cache from options are passed to the build command

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

Default: no cache to options are passed to the build command

fileoptionalstringfileoptionalstrfileoptionalStringFileoptionalstringFileoptional*string#
Path to the Dockerfile (relative to the directory).

Default: no file is passed

idstringidstridStringIdstringId*stringrequired#
Logical identifier for the asset.
imageTagoptionalstringimage_tagoptionalstrimageTagoptionalStringImageTagoptionalstringImageTagoptional*string#
The docker image tag to use for tagging pushed images.

Default: this parameter is REQUIRED after 1.21.0

This field is required if imageParameterName is ommited (otherwise, the app won't be able to find the image).

networkModeoptionalstringnetwork_modeoptionalstrnetworkModeoptionalStringNetworkModeoptionalstringNetworkModeoptional*string#
Networking mode for the RUN commands during build.

Default: no networking mode specified

outputsoptionalstring[]outputsoptionaltyping.List[str]outputsoptionalList<String>Outputsoptionalstring[]Outputsoptional*[]*string#
Outputs to pass to the `docker build` command.

Default: no outputs are passed to the build command (default outputs are used)

packagingstringpackagingstrpackagingStringPackagingstringPackaging*stringrequired#
Type of asset.
pathstringpathstrpathStringPathstringPath*stringrequired#
Path on disk to the asset.
platformoptionalstringplatformoptionalstrplatformoptionalStringPlatformoptionalstringPlatformoptional*string#
Platform to build for.

Default: current machine platform

Requires Docker Buildx.

repositoryNameoptionalstringrepository_nameoptionalstrrepositoryNameoptionalStringRepositoryNameoptionalstringRepositoryNameoptional*string#
ECR repository name, if omitted a default name based on the asset's ID is used instead.

Default: this parameter is REQUIRED after 1.21.0

Specify this property if you need to statically address the image, e.g. from a Kubernetes Pod. Note, this is only the repository name, without the registry and the tag parts.

sourceHashstringsource_hashstrsourceHashStringSourceHashstringSourceHash*stringrequired#
The hash of the asset source.
targetoptionalstringtargetoptionalstrtargetoptionalStringTargetoptionalstringTargetoptional*string#
Docker target to build to.

Default: no build target