AWS CDK Reference

Appearance

v2.275.0

DockerImageDestination Struct ​

Where to publish docker images.

Source
node_modules/@aws-cdk/cloud-assembly-schema/lib/assets/docker-image-asset.d.ts

Example ​

ts
// 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';

declare const assumeRoleAdditionalOptions: any;
const dockerImageDestination: cloud_assembly_schema.DockerImageDestination = {
  imageTag: 'imageTag',
  repositoryName: 'repositoryName',

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

Properties ​

assumeRoleAdditionalOptionsoptional{ [key: string]: any }assume_role_additional_optionsoptionaltyping.Mapping[str, Any]assumeRoleAdditionalOptionsoptionalMap<String, Object>AssumeRoleAdditionalOptionsoptionalIDictionary<string, object>AssumeRoleAdditionalOptionsoptional*map[string]interface{}#
Additional options to pass to STS when assuming the role.

Default: No additional options.

  • RoleArn should not be used. Use the dedicated assumeRoleArn property instead.
  • ExternalId should not be used. Use the dedicated assumeRoleExternalId instead.
assumeRoleArnoptionalstringassume_role_arnoptionalstrassumeRoleArnoptionalStringAssumeRoleArnoptionalstringAssumeRoleArnoptional*string#
The role that needs to be assumed while publishing this asset.

Default: No role will be assumed

assumeRoleExternalIdoptionalstringassume_role_external_idoptionalstrassumeRoleExternalIdoptionalStringAssumeRoleExternalIdoptionalstringAssumeRoleExternalIdoptional*string#
The ExternalId that needs to be supplied while assuming this role.

Default: No ExternalId will be supplied

imageTagstringimage_tagstrimageTagStringImageTagstringImageTag*stringrequired#
Tag of the image to publish.
regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string#
The region where this asset will need to be published.

Default: Current region

repositoryNamestringrepository_namestrrepositoryNameStringRepositoryNamestringRepositoryName*stringrequired#
Name of the ECR repository to publish to.