AWS CDK Reference

Appearance

v2.276.0

Experimental

@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ContainerDistribution Struct ​

The regional distribution settings to use for a container build.

Stability
Experimental
Source
lib/distribution-configuration.ts

Example ​

ts
const ecrRepository = ecr.Repository.fromRepositoryName(this, 'ECRRepository', 'my-repo');
const containerRepository = imagebuilder.Repository.fromEcr(ecrRepository);
const containerDistributionConfiguration = new imagebuilder.DistributionConfiguration(
  this,
  'ContainerDistributionConfiguration'
);

containerDistributionConfiguration.addContainerDistributions({
  containerRepository,
  containerDescription: 'Test container image',
  containerTags: ['latest', 'latest-1.0']
});
python
ecr_repository = ecr.Repository.from_repository_name(self, "ECRRepository", "my-repo")
container_repository = imagebuilder.Repository.from_ecr(ecr_repository)
container_distribution_configuration = imagebuilder.DistributionConfiguration(self, "ContainerDistributionConfiguration")

container_distribution_configuration.add_container_distributions(
    container_repository=container_repository,
    container_description="Test container image",
    container_tags=["latest", "latest-1.0"]
)
java
IRepository ecrRepository = Repository.fromRepositoryName(this, "ECRRepository", "my-repo");
Repository containerRepository = Repository.fromEcr(ecrRepository);
DistributionConfiguration containerDistributionConfiguration = new DistributionConfiguration(this, "ContainerDistributionConfiguration");

containerDistributionConfiguration.addContainerDistributions(ContainerDistribution.builder()
        .containerRepository(containerRepository)
        .containerDescription("Test container image")
        .containerTags(List.of("latest", "latest-1.0"))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.AWS.ImageBuilder.Alpha
var ecrRepository = Repository.FromRepositoryName(this, "ECRRepository", "my-repo");
var containerRepository = Repository.FromEcr(ecrRepository);
var containerDistributionConfiguration = new DistributionConfiguration(this, "ContainerDistributionConfiguration");

containerDistributionConfiguration.AddContainerDistributions(new ContainerDistribution {
    ContainerRepository = containerRepository,
    ContainerDescription = "Test container image",
    ContainerTags = new [] { "latest", "latest-1.0" }
});
go
// Install: go get github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2
ecrRepository := ecr.Repository_FromRepositoryName(this, jsii.String("ECRRepository"), jsii.String("my-repo"))
containerRepository := imagebuilder.Repository_FromEcr(ecrRepository)
containerDistributionConfiguration := imagebuilder.NewDistributionConfiguration(this, jsii.String("ContainerDistributionConfiguration"))

containerDistributionConfiguration.AddContainerDistributions(&ContainerDistribution{
	ContainerRepository: ContainerRepository,
	ContainerDescription: jsii.String("Test container image"),
	ContainerTags: []*string{
		jsii.String("latest"),
		jsii.String("latest-1.0"),
	},
})

Properties ​

containerDescriptionoptionalstringcontainer_descriptionoptionalstrcontainerDescriptionoptionalStringContainerDescriptionoptionalstringContainerDescriptionoptional*string= None#
The description of the container image.
containerRepositoryRepositorycontainer_repositoryRepositorycontainerRepositoryRepositoryContainerRepositoryRepositoryContainerRepositoryRepositoryrequired#
The destination repository to distribute the output container to.

Default: The target repository in the container recipe is used

containerTagsoptionalstring[]container_tagsoptionaltyping.List[str]containerTagsoptionalList<String>ContainerTagsoptionalstring[]ContainerTagsoptional*[]*string= None#
The additional tags to apply to the distributed container images.
regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string#
The target region to distribute containers to.

Default: The current region is used