View a markdown version of this page

AWS::ImageBuilder::DistributionConfiguration LaunchPermissionConfiguration - 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 LaunchPermissionConfiguration

Describes the configuration for a launch permission. The launch permission modification request is sent to the Amazon EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set userGroups to the value all. See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute.

Syntax

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

JSON

{
  "OrganizationalUnitArns" : [ String, ... ],
  "OrganizationArns" : [ String, ... ],
  "UserGroups" : [ String, ... ],
  "UserIds" : [ String, ... ]
}

YAML

  OrganizationalUnitArns: 
    - String
  OrganizationArns: 
    - String
  UserGroups: 
    - String
  UserIds: 
    - String

Properties

OrganizationalUnitArns

The ARN for an AWS Organizations organizational unit (OU) that you want to share your AMI with. For more information about key concepts for AWS Organizations, see AWS Organizations terminology and concepts.

Required: No

Type: Array of String

Minimum: 1

Maximum: 25

Update requires: No interruption

OrganizationArns

The ARN for an AWS Organization that you want to share your AMI with. For more information, see What is AWS Organizations?.

Required: No

Type: Array of String

Minimum: 1

Maximum: 25

Update requires: No interruption

UserGroups

The name of the group that you want to grant launch permission to. The only supported value is all, which makes the distributed AMI public.

Required: No

Type: Array of String

Update requires: No interruption

UserIds

The AWS account IDs to grant launch permission to. Each listed account can use the distributed AMI to launch instances.

Required: No

Type: Array of String

Minimum: 1

Maximum: 1536

Update requires: No interruption