AmiDistributionConfiguration

Define and configure the output AMIs of the pipeline.

amiTags

The tags to apply to AMIs distributed to this Region.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z0-9\s_.:/=+\-@]*$

Value Length Constraints: Maximum length of 256.

Required: No

description

The description to apply to the distributed AMI. Image Builder sets this as the output AMI's description in each target Region and account. If you don't specify a description, the AMI in the build Region uses the image recipe's description, if the recipe has one. Copies distributed to other Regions and accounts don't receive a default description.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

kmsKeyId

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

launchPermission

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

Type: LaunchPermissionConfiguration object

Required: No

name

The name of the output AMI. The name must include the {{ imagebuilder:buildDate }} dynamic tag so that each build produces a uniquely named AMI. If you don't specify a name, Image Builder names the output AMI with the image name followed by the build timestamp, for example my-image 2022-10-26T22-30-05.912619Z.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 127.

Pattern: ^[-_A-Za-z0-9{][-_A-Za-z0-9\s:{}\.]+[-_A-Za-z0-9}]$

Required: No

targetAccountIds

The AWS account IDs to distribute the AMI to in this Region. Each listed account receives its own copy of the output AMI. If you don't specify accounts, Image Builder distributes the AMI only to your own account.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 1536 items.

Pattern: ^[0-9]{12}$

Required: No

AmiDistributionConfiguration

Contents

See Also