Skip to content
v2.277.0

DockerImageDestination Struct ​

Where to publish docker images.

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',
};
python
from aws_cdk.cloud_assembly_schema import DockerImageDestination
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import cloud_assembly_schema

# assume_role_additional_options: Any

docker_image_destination = DockerImageDestination(
    image_tag="imageTag",
    repository_name="repositoryName",

    # the properties below are optional
    assume_role_additional_options={
        "assume_role_additional_options_key": assume_role_additional_options
    },
    assume_role_arn="assumeRoleArn",
    assume_role_external_id="assumeRoleExternalId",
    region="region"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cloud_assembly_schema.*;

Object assumeRoleAdditionalOptions;

DockerImageDestination dockerImageDestination = DockerImageDestination.builder()
        .imageTag("imageTag")
        .repositoryName("repositoryName")

        // the properties below are optional
        .assumeRoleAdditionalOptions(Map.of(
                "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
        .assumeRoleArn("assumeRoleArn")
        .assumeRoleExternalId("assumeRoleExternalId")
        .region("region")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Cloud_assembly_schema;

var assumeRoleAdditionalOptions;

var dockerImageDestination = new DockerImageDestination {
    ImageTag = "imageTag",
    RepositoryName = "repositoryName",

    // the properties below are optional
    AssumeRoleAdditionalOptions = new Dictionary<string, object> {
        { "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions }
    },
    AssumeRoleArn = "assumeRoleArn",
    AssumeRoleExternalId = "assumeRoleExternalId",
    Region = "region"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var assumeRoleAdditionalOptions interface{}

dockerImageDestination := &DockerImageDestination{
	ImageTag: jsii.String("imageTag"),
	RepositoryName: jsii.String("repositoryName"),

	// the properties below are optional
	AssumeRoleAdditionalOptions: map[string]interface{}{
		"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
	},
	AssumeRoleArn: jsii.String("assumeRoleArn"),
	AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
	Region: jsii.String("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*string required #
Tag of the image to publish.
regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string #
The region where this asset will need to be published.

Default: Current region

repositoryNamestringrepository_namestrrepositoryNameStringRepositoryNamestringRepositoryName*string required #
Name of the ECR repository to publish to.