Amazon EC2 Image Builder · Schema
AmiDistributionConfiguration
Define and configure the output AMIs of the pipeline.
Amazon Web ServicesAutomationContainer ImagesEC2Image BuildingVirtual Machine Images
Properties
| Name | Type | Description |
|---|---|---|
| name | object | |
| description | object | |
| targetAccountIds | object | |
| amiTags | object | |
| kmsKeyId | object | |
| launchPermission | object |
JSON Schema
{
"$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-ami-distribution-configuration-schema.json",
"title": "AmiDistributionConfiguration",
"description": "Define and configure the output AMIs of the pipeline.",
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/AmiNameString"
},
{
"description": "The name of the output AMI."
}
]
},
"description": {
"allOf": [
{
"$ref": "#/components/schemas/NonEmptyString"
},
{
"description": "The description of the AMI distribution configuration. Minimum and maximum length are in characters."
}
]
},
"targetAccountIds": {
"allOf": [
{
"$ref": "#/components/schemas/AccountList"
},
{
"description": "The ID of an account to which you want to distribute an image."
}
]
},
"amiTags": {
"allOf": [
{
"$ref": "#/components/schemas/TagMap"
},
{
"description": "The tags to apply to AMIs distributed to this Region."
}
]
},
"kmsKeyId": {
"allOf": [
{
"$ref": "#/components/schemas/NonEmptyString"
},
{
"description": "The KMS key identifier used to encrypt the distributed image."
}
]
},
"launchPermission": {
"allOf": [
{
"$ref": "#/components/schemas/LaunchPermissionConfiguration"
},
{
"description": "Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances."
}
]
}
}
}