Skip to content
v2.277.0

AmiDistributionConfigurationProperty Struct ​

Define and configure the output AMIs of the pipeline.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_imagebuilder as imagebuilder } from 'aws-cdk-lib';
const amiDistributionConfigurationProperty: imagebuilder.CfnDistributionConfiguration.AmiDistributionConfigurationProperty = {
  amiTags: {
    amiTagsKey: 'amiTags',
  },
  description: 'description',
  kmsKeyId: 'kmsKeyId',
  launchPermissionConfiguration: {
    organizationalUnitArns: ['organizationalUnitArns'],
    organizationArns: ['organizationArns'],
    userGroups: ['userGroups'],
    userIds: ['userIds'],
  },
  name: 'name',
  targetAccountIds: ['targetAccountIds'],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_imagebuilder as imagebuilder

ami_distribution_configuration_property = imagebuilder.CfnDistributionConfiguration.AmiDistributionConfigurationProperty(
    ami_tags={
        "ami_tags_key": "amiTags"
    },
    description="description",
    kms_key_id="kmsKeyId",
    launch_permission_configuration=imagebuilder.CfnDistributionConfiguration.LaunchPermissionConfigurationProperty(
        organizational_unit_arns=["organizationalUnitArns"],
        organization_arns=["organizationArns"],
        user_groups=["userGroups"],
        user_ids=["userIds"]
    ),
    name="name",
    target_account_ids=["targetAccountIds"]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.imagebuilder.*;

AmiDistributionConfigurationProperty amiDistributionConfigurationProperty = AmiDistributionConfigurationProperty.builder()
        .amiTags(Map.of(
                "amiTagsKey", "amiTags"))
        .description("description")
        .kmsKeyId("kmsKeyId")
        .launchPermissionConfiguration(LaunchPermissionConfigurationProperty.builder()
                .organizationalUnitArns(List.of("organizationalUnitArns"))
                .organizationArns(List.of("organizationArns"))
                .userGroups(List.of("userGroups"))
                .userIds(List.of("userIds"))
                .build())
        .name("name")
        .targetAccountIds(List.of("targetAccountIds"))
        .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.AWS.ImageBuilder;

var amiDistributionConfigurationProperty = new AmiDistributionConfigurationProperty {
    AmiTags = new Dictionary<string, string> {
        { "amiTagsKey", "amiTags" }
    },
    Description = "description",
    KmsKeyId = "kmsKeyId",
    LaunchPermissionConfiguration = new LaunchPermissionConfigurationProperty {
        OrganizationalUnitArns = new [] { "organizationalUnitArns" },
        OrganizationArns = new [] { "organizationArns" },
        UserGroups = new [] { "userGroups" },
        UserIds = new [] { "userIds" }
    },
    Name = "name",
    TargetAccountIds = new [] { "targetAccountIds" }
};
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"

amiDistributionConfigurationProperty := &AmiDistributionConfigurationProperty{
	AmiTags: map[string]*string{
		"amiTagsKey": jsii.String("amiTags"),
	},
	Description: jsii.String("description"),
	KmsKeyId: jsii.String("kmsKeyId"),
	LaunchPermissionConfiguration: &LaunchPermissionConfigurationProperty{
		OrganizationalUnitArns: []*string{
			jsii.String("organizationalUnitArns"),
		},
		OrganizationArns: []*string{
			jsii.String("organizationArns"),
		},
		UserGroups: []*string{
			jsii.String("userGroups"),
		},
		UserIds: []*string{
			jsii.String("userIds"),
		},
	},
	Name: jsii.String("name"),
	TargetAccountIds: []*string{
		jsii.String("targetAccountIds"),
	},
}

Properties ​

amiTagsoptionalIResolvable | { [key: string]: string }ami_tagsoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]amiTagsoptionalIResolvableAmiTagsoptionalIResolvableAmiTagsoptionalinterface{}#
The tags to apply to AMIs distributed to this Region.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the AMI distribution configuration.

Minimum and maximum length are in characters.

kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string#
The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt the distributed image.

This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .

launchPermissionConfigurationoptionalIResolvable | CfnDistributionConfiguration.LaunchPermissionConfigurationPropertylaunch_permission_configurationoptionaltyping.Union[IResolvable, LaunchPermissionConfigurationProperty]launchPermissionConfigurationoptionalIResolvableLaunchPermissionConfigurationoptionalIResolvableLaunchPermissionConfigurationoptionalinterface{}#
Launch permissions can be used to configure which AWS account s can use the AMI to launch instances.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name of the output AMI.
targetAccountIdsoptionalstring[]target_account_idsoptionaltyping.List[str]targetAccountIdsoptionalList<String>TargetAccountIdsoptionalstring[]TargetAccountIdsoptional*[]*string#
The ID of an account to which you want to distribute an image.