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 the launch permission authorized accounts to all. See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute.

Amazon Web ServicesAutomationContainer ImagesEC2Image BuildingVirtual Machine Images

Properties

Name Type Description
userIds object
userGroups object
organizationArns object
organizationalUnitArns object
View JSON Schema on GitHub

JSON Schema

ec2-image-builder-launch-permission-configuration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ec2-image-builder/refs/heads/main/json-schema/ec2-image-builder-launch-permission-configuration-schema.json",
  "title": "LaunchPermissionConfiguration",
  "description": "Describes the configuration for a launch permission. The launch permission modification request is sent to the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html\">Amazon EC2 ModifyImageAttribute</a> API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to <code>all</code>. See the examples for making an AMI public at <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html\">Amazon EC2 ModifyImageAttribute</a>.",
  "type": "object",
  "properties": {
    "userIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountList"
        },
        {
          "description": "The Amazon Web Services account ID."
        }
      ]
    },
    "userGroups": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringList"
        },
        {
          "description": "The name of the group."
        }
      ]
    },
    "organizationArns": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationArnList"
        },
        {
          "description": "The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html\">What is Organizations?</a>."
        }
      ]
    },
    "organizationalUnitArns": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationalUnitArnList"
        },
        {
          "description": "The ARN for an Organizations organizational unit (OU) that you want to share your AMI with. For more information about key concepts for Organizations, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html\">Organizations terminology and concepts</a>."
        }
      ]
    }
  }
}