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

This is the new AWS 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 AWS 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 of the AMI distribution configuration. Minimum and maximum length are in characters.

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.

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 ID of an account to which you want to distribute an image.

Required: No

Type: Array of String

Minimum: 1

Maximum: 1536

Update requires: No interruption