Skip to content

AmiDistributionConfiguration

Source code in docs_src/capo_imagebuilder/types/ami_distribution_configuration.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class AmiDistributionConfiguration(TypedDict, closed=True):
    name: NotRequired["capo_imagebuilder.types.ami_name_string.AmiNameString"]
    """<p>The name of the output AMI. The name must include the <code>{{ imagebuilder:buildDate }}</code> 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 <code>my-image 2022-10-26T22-30-05.912619Z</code>.</p>"""
    description: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>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.</p>"""
    target_account_ids: NotRequired["capo_imagebuilder.types.account_list.AccountList"]
    """<p>The Amazon Web Services 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.</p>"""
    ami_tags: NotRequired["capo_imagebuilder.types.tag_map.TagMap"]
    """<p>The tags to apply to AMIs distributed to this Region.</p>"""
    kms_key_id: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>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 <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">Key identifiers (KeyId)</a> in the <i>Key Management Service Developer Guide</i>.</p>"""
    launch_permission: NotRequired[
        "capo_imagebuilder.types.launch_permission_configuration.LaunchPermissionConfiguration"
    ]
    """<p>Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.</p>"""

ami_tags instance-attribute 

ami_tags: NotRequired[TagMap]

The tags to apply to AMIs distributed to this Region.

description instance-attribute 

description: NotRequired[NonEmptyString]

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.

kms_key_id instance-attribute 

kms_key_id: NotRequired[NonEmptyString]

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 Key Management Service Developer Guide.

launch_permission instance-attribute 

launch_permission: NotRequired[LaunchPermissionConfiguration]

Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.

name instance-attribute 

name: NotRequired[AmiNameString]

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.

target_account_ids instance-attribute 

target_account_ids: NotRequired[AccountList]

The Amazon Web Services 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.