Skip to content

InfrastructureConfiguration

Source code in docs_src/capo_imagebuilder/types/infrastructure_configuration.py
class InfrastructureConfiguration(TypedDict, closed=True):
    arn: NotRequired["capo_imagebuilder.types.image_builder_arn.ImageBuilderArn"]
    """<p>The Amazon Resource Name (ARN) of the infrastructure configuration.</p>"""
    name: NotRequired["capo_imagebuilder.types.resource_name.ResourceName"]
    """<p>The name of the infrastructure configuration.</p>"""
    description: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The description of the infrastructure configuration.</p>"""
    instance_types: NotRequired[
        "capo_imagebuilder.types.instance_type_list.InstanceTypeList"
    ]
    """<p>The instance types of the infrastructure configuration.</p>"""
    instance_profile_name: NotRequired[
        "capo_imagebuilder.types.instance_profile_name_type.InstanceProfileNameType"
    ]
    """<p>The instance profile of the infrastructure configuration.</p>"""
    security_group_ids: NotRequired[
        "capo_imagebuilder.types.security_group_ids.SecurityGroupIds"
    ]
    """<p>The security group IDs of the infrastructure configuration.</p>"""
    subnet_id: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The subnet ID of the infrastructure configuration.</p>"""
    logging: NotRequired["capo_imagebuilder.types.logging.Logging"]
    """<p>The logging configuration of the infrastructure configuration. When you configure S3 logs, Image Builder writes logs from the build and test process to the specified bucket under the key prefix.</p>"""
    key_pair: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon EC2 key pair of the infrastructure configuration.</p>"""
    terminate_instance_on_failure: NotRequired[
        "capo_imagebuilder.types.nullable_boolean.NullableBoolean"
    ]
    """<p>Indicates whether Image Builder terminates the build and test instances when the image build fails. When <code>false</code>, Image Builder retains the instance so that you can debug it.</p>"""
    sns_topic_arn: NotRequired[
        "capo_imagebuilder.types.non_empty_string.NonEmptyString"
    ]
    """<p>The Amazon Resource Name (ARN) of the SNS topic to which Image Builder sends image build event notifications. Specify a standard topic. Image Builder doesn't support FIFO topics.</p> <note> <p>EC2 Image Builder can't send notifications to SNS topics that are encrypted using keys from other accounts. If your SNS topic is encrypted, the key must be owned by the same account that owns your Image Builder resources.</p> </note>"""
    date_created: NotRequired["capo_imagebuilder.types.date_time.DateTime"]
    """<p>The date on which the infrastructure configuration was created.</p>"""
    date_updated: NotRequired["capo_imagebuilder.types.date_time.DateTime"]
    """<p>The date on which the infrastructure configuration was last updated.</p>"""
    resource_tags: NotRequired[
        "capo_imagebuilder.types.resource_tag_map.ResourceTagMap"
    ]
    """<p>The metadata tags assigned to the Amazon EC2 build and test instances that Image Builder launches during image creation.</p>"""
    instance_metadata_options: NotRequired[
        "capo_imagebuilder.types.instance_metadata_options.InstanceMetadataOptions"
    ]
    """<p>The instance metadata option settings for the infrastructure configuration.</p>"""
    tags: NotRequired["capo_imagebuilder.types.tag_map.TagMap"]
    """<p>The tags of the infrastructure configuration.</p>"""
    placement: NotRequired["capo_imagebuilder.types.placement.Placement"]
    """<p>The instance placement settings that define where the build and test instances that Image Builder launches during image creation run. These settings don't affect instances that you launch from the output image.</p>"""
    terminate_instance_on_completion: NotRequired[
        "capo_imagebuilder.types.nullable_boolean.NullableBoolean"
    ]
    """<p>Specifies whether Image Builder terminates build and test instances when image creation ends without a failure.</p>"""
    parent_instance: NotRequired[
        "capo_imagebuilder.types.parent_instance_configuration.ParentInstanceConfiguration"
    ]
    """<p>The Amazon EC2 Auto Scaling group that Image Builder takes the build instance from, instead of launching a new instance. This applies only to the build phase.</p>"""

arn instance-attribute

arn: NotRequired[ImageBuilderArn]

The Amazon Resource Name (ARN) of the infrastructure configuration.

date_created instance-attribute

date_created: NotRequired[DateTime]

The date on which the infrastructure configuration was created.

date_updated instance-attribute

date_updated: NotRequired[DateTime]

The date on which the infrastructure configuration was last updated.

description instance-attribute

description: NotRequired[NonEmptyString]

The description of the infrastructure configuration.

instance_metadata_options instance-attribute

instance_metadata_options: NotRequired[InstanceMetadataOptions]

The instance metadata option settings for the infrastructure configuration.

instance_profile_name instance-attribute

instance_profile_name: NotRequired[InstanceProfileNameType]

The instance profile of the infrastructure configuration.

instance_types instance-attribute

instance_types: NotRequired[InstanceTypeList]

The instance types of the infrastructure configuration.

key_pair instance-attribute

key_pair: NotRequired[NonEmptyString]

The Amazon EC2 key pair of the infrastructure configuration.

logging instance-attribute

logging: NotRequired[Logging]

The logging configuration of the infrastructure configuration. When you configure S3 logs, Image Builder writes logs from the build and test process to the specified bucket under the key prefix.

name instance-attribute

name: NotRequired[ResourceName]

The name of the infrastructure configuration.

parent_instance instance-attribute

parent_instance: NotRequired[ParentInstanceConfiguration]

The Amazon EC2 Auto Scaling group that Image Builder takes the build instance from, instead of launching a new instance. This applies only to the build phase.

placement instance-attribute

placement: NotRequired[Placement]

The instance placement settings that define where the build and test instances that Image Builder launches during image creation run. These settings don't affect instances that you launch from the output image.

resource_tags instance-attribute

resource_tags: NotRequired[ResourceTagMap]

The metadata tags assigned to the Amazon EC2 build and test instances that Image Builder launches during image creation.

security_group_ids instance-attribute

security_group_ids: NotRequired[SecurityGroupIds]

The security group IDs of the infrastructure configuration.

sns_topic_arn instance-attribute

sns_topic_arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the SNS topic to which Image Builder sends image build event notifications. Specify a standard topic. Image Builder doesn't support FIFO topics.

EC2 Image Builder can't send notifications to SNS topics that are encrypted using keys from other accounts. If your SNS topic is encrypted, the key must be owned by the same account that owns your Image Builder resources.

subnet_id instance-attribute

subnet_id: NotRequired[NonEmptyString]

The subnet ID of the infrastructure configuration.

tags instance-attribute

tags: NotRequired[TagMap]

The tags of the infrastructure configuration.

terminate_instance_on_completion instance-attribute

terminate_instance_on_completion: NotRequired[NullableBoolean]

Specifies whether Image Builder terminates build and test instances when image creation ends without a failure.

terminate_instance_on_failure instance-attribute

terminate_instance_on_failure: NotRequired[NullableBoolean]

Indicates whether Image Builder terminates the build and test instances when the image build fails. When false, Image Builder retains the instance so that you can debug it.