1.204.0

interface ContainerImageAssetMetadataEntry

LanguageType name
.NETAmazon.CDK.CloudAssembly.Schema.ContainerImageAssetMetadataEntry
Javasoftware.amazon.awscdk.cloudassembly.schema.ContainerImageAssetMetadataEntry
Pythonaws_cdk.cloud_assembly_schema.ContainerImageAssetMetadataEntry
TypeScript (source)@aws-cdk/cloud-assembly-schema » ContainerImageAssetMetadataEntry

Metadata Entry spec for container images.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';
const containerImageAssetMetadataEntry: cloud_assembly_schema.ContainerImageAssetMetadataEntry = {
  id: 'id',
  packaging: 'packaging',
  path: 'path',
  sourceHash: 'sourceHash',

  // the properties below are optional
  buildArgs: {
    buildArgsKey: 'buildArgs',
  },
  file: 'file',
  imageNameParameter: 'imageNameParameter',
  imageTag: 'imageTag',
  networkMode: 'networkMode',
  platform: 'platform',
  repositoryName: 'repositoryName',
  target: 'target',
};

Properties

NameTypeDescription
idstringLogical identifier for the asset.
packagingstringType of asset.
pathstringPath on disk to the asset.
sourceHashstringThe hash of the asset source.
buildArgs?{ [string]: string }Build args to pass to the docker build command.
file?stringPath to the Dockerfile (relative to the directory).
imageNameParameter?⚠️stringECR Repository name and repo digest (separated by "@sha256:") where this image is stored.
imageTag?stringThe docker image tag to use for tagging pushed images.
networkMode?stringNetworking mode for the RUN commands during build.
platform?stringPlatform to build for.
repositoryName?stringECR repository name, if omitted a default name based on the asset's ID is used instead.
target?stringDocker target to build to.

id

Type: string

Logical identifier for the asset.

packaging

Type: string

Type of asset.

path

Type: string

Path on disk to the asset.

sourceHash

Type: string

The hash of the asset source.

buildArgs?

Type: { [string]: string } (optional, default: no build args are passed)

Build args to pass to the docker build command.

file?

Type: string (optional, default: no file is passed)

Path to the Dockerfile (relative to the directory).

imageNameParameter?⚠️

⚠️ Deprecated: specify repositoryName and imageTag instead, and then you know where the image will go.

Type: string (optional, default: undefined If not specified, repositoryName and imageTag are required because otherwise how will the stack know where to find the asset, ha?)

ECR Repository name and repo digest (separated by "@sha256:") where this image is stored.

imageTag?

Type: string (optional, default: this parameter is REQUIRED after 1.21.0)

The docker image tag to use for tagging pushed images.

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

networkMode?

Type: string (optional, default: no networking mode specified)

Networking mode for the RUN commands during build.

platform?

Type: string (optional, default: current machine platform)

Platform to build for.

Requires Docker Buildx.

repositoryName?

Type: string (optional, default: this parameter is REQUIRED after 1.21.0)

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

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.

target?

Type: string (optional, default: no build target)

Docker target to build to.

← PreviousNext →