View a markdown version of this page

AWS::ImageBuilder::DistributionConfiguration AmiDistributionConfiguration - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::ImageBuilder::DistributionConfiguration AmiDistributionConfiguration

Define and configure the output AMIs of the pipeline.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "AmiTags" : {Key: Value, ...},
  "Description" : String,
  "KmsKeyId" : String,
  "LaunchPermissionConfiguration" : LaunchPermissionConfiguration,
  "Name" : String,
  "TargetAccountIds" : [ String, ... ]
}

Properties

AmiTags

The tags to apply to AMIs distributed to this Region.

Required: No

Type: Object of String

Pattern: .{1,}

Update requires: No interruption

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.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

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.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

LaunchPermissionConfiguration

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

Required: No

Type: LaunchPermissionConfiguration

Update requires: No interruption

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.

Required: No

Type: String

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

Minimum: 1

Maximum: 127

Update requires: No interruption

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.

Required: No

Type: Array of String

Minimum: 1

Maximum: 1536

Update requires: No interruption