aws-cdk-lib.cloud_assembly_schema.DockerImageDestination

interface DockerImageDestination

LanguageType name
.NETAmazon.CDK.CloudAssembly.Schema.DockerImageDestination
Gogithub.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#DockerImageDestination
Javasoftware.amazon.awscdk.cloudassembly.schema.DockerImageDestination
Pythonaws_cdk.cloud_assembly_schema.DockerImageDestination
TypeScript (source)aws-cdk-lib » cloud_assembly_schema » DockerImageDestination

Obtainable from AssetManifestBuilder.addDockerImageAsset(), AssetManifestBuilder.defaultAddDockerImageAsset()

Where to publish docker images.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cloud_assembly_schema } from 'aws-cdk-lib';
const dockerImageDestination: cloud_assembly_schema.DockerImageDestination = {
  imageTag: 'imageTag',
  repositoryName: 'repositoryName',

  // the properties below are optional
  assumeRoleArn: 'assumeRoleArn',
  assumeRoleExternalId: 'assumeRoleExternalId',
  region: 'region',
};

Properties

NameTypeDescription
imageTagstringTag of the image to publish.
repositoryNamestringName of the ECR repository to publish to.
assumeRoleArn?stringThe role that needs to be assumed while publishing this asset.
assumeRoleExternalId?stringThe ExternalId that needs to be supplied while assuming this role.
region?stringThe region where this asset will need to be published.

imageTag

Type: string

Tag of the image to publish.


repositoryName

Type: string

Name of the ECR repository to publish to.


assumeRoleArn?

Type: string (optional, default: No role will be assumed)

The role that needs to be assumed while publishing this asset.


assumeRoleExternalId?

Type: string (optional, default: No ExternalId will be supplied)

The ExternalId that needs to be supplied while assuming this role.


region?

Type: string (optional, default: Current region)

The region where this asset will need to be published.