aws-cdk-lib.DockerImageAssetLocation

interface DockerImageAssetLocation

LanguageType name
.NETAmazon.CDK.DockerImageAssetLocation
Gogithub.com/aws/aws-cdk-go/awscdk/v2#DockerImageAssetLocation
Javasoftware.amazon.awscdk.DockerImageAssetLocation
Pythonaws_cdk.DockerImageAssetLocation
TypeScript (source)aws-cdk-lib » DockerImageAssetLocation

Obtainable from AppStagingSynthesizer.addDockerImageAsset(), BootstraplessSynthesizer.addDockerImageAsset(), CliCredentialsStackSynthesizer.addDockerImageAsset(), DefaultStackSynthesizer.addDockerImageAsset(), LegacyStackSynthesizer.addDockerImageAsset(), NestedStackSynthesizer.addDockerImageAsset(), StackSynthesizer.addDockerImageAsset(), StackSynthesizer.cloudFormationLocationFromDockerImageAsset()

The location of the published docker image.

This is where the image can be consumed at runtime.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const dockerImageAssetLocation: cdk.DockerImageAssetLocation = {
  imageUri: 'imageUri',
  repositoryName: 'repositoryName',

  // the properties below are optional
  imageTag: 'imageTag',
};

Properties

NameTypeDescription
imageUristringThe URI of the image in Amazon ECR (including a tag).
repositoryNamestringThe name of the ECR repository.
imageTag?stringThe tag of the image in Amazon ECR.

imageUri

Type: string

The URI of the image in Amazon ECR (including a tag).


repositoryName

Type: string

The name of the ECR repository.


imageTag?

Type: string (optional, default: the hash of the asset, or the dockerTagPrefix concatenated with the asset hash if a dockerTagPrefix is specified in the stack synthesizer)

The tag of the image in Amazon ECR.