interface AmiDistributionConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.ImageBuilder.CfnDistributionConfiguration.AmiDistributionConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsimagebuilder#CfnDistributionConfiguration_AmiDistributionConfigurationProperty`
Java	`software.amazon.awscdk.services.imagebuilder.CfnDistributionConfiguration.AmiDistributionConfigurationProperty`
Python	`aws_cdk.aws_imagebuilder.CfnDistributionConfiguration.AmiDistributionConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_imagebuilder` » `CfnDistributionConfiguration` » `AmiDistributionConfigurationProperty`

Define and configure the output AMIs of the pipeline.

Example

// 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'],
};

Properties

Name	Type	Description
amiTags?	`{ [string]: string } \|` `IResolvable`	The tags to apply to AMIs distributed to this Region.
description?	`string`	The description of the AMI distribution configuration.
kmsKeyId?	`string`	The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt the distributed image.
launchPermissionConfiguration?	`IResolvable` `\|` `LaunchPermissionConfigurationProperty`	Launch permissions can be used to configure which AWS account s can use the AMI to launch instances.
name?	`string`	The name of the output AMI.
targetAccountIds?	`string[]`	The ID of an account to which you want to distribute an image.

amiTags?

Type: { [string]: string } | IResolvable (optional)

The tags to apply to AMIs distributed to this Region.

description?

Type: string (optional)

The description of the AMI distribution configuration.

Minimum and maximum length are in characters.

kmsKeyId?

Type: string (optional)

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 .

launchPermissionConfiguration?

Type: IResolvable | LaunchPermissionConfigurationProperty (optional)

Launch permissions can be used to configure which AWS account s can use the AMI to launch instances.

name?

Type: string (optional)

The name of the output AMI.

targetAccountIds?

Type: string[] (optional)

The ID of an account to which you want to distribute an image.