Skip to content

Instance

Source code in docs_src/capo_auto_scaling/types/instance.py
class Instance(TypedDict, closed=True):
    instance_id: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len19.XmlStringMaxLen19"
    ]
    """<p>The ID of the instance.</p>"""
    instance_type: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The instance type of the EC2 instance.</p>"""
    availability_zone: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The Availability Zone in which the instance is running.</p>"""
    availability_zone_id: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p> The Availability Zone ID where the instance was launched. </p>"""
    lifecycle_state: NotRequired[
        "capo_auto_scaling.types.lifecycle_state.LifecycleState"
    ]
    """<p>A description of the current lifecycle state. The <code>Quarantined</code> state is not used. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-lifecycle.html">Amazon EC2 Auto Scaling instance lifecycle</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p>"""
    health_status: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len32.XmlStringMaxLen32"
    ]
    """<p>The last reported health status of the instance. <code>Healthy</code> means that the instance is healthy and should remain in service. <code>Unhealthy</code> means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.</p>"""
    launch_configuration_name: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The launch configuration associated with the instance.</p>"""
    launch_template: NotRequired[
        "capo_auto_scaling.types.launch_template_specification.LaunchTemplateSpecification"
    ]
    """<p>The launch template for the instance.</p>"""
    image_id: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p> The ID of the Amazon Machine Image (AMI) used for the instance's current root volume. This value reflects the most recent AMI applied to the instance, including updates made through root volume replacement operations. </p> <p> This field appears for: </p> <ul> <li> <p>Instances with root volume replacements through Instance Refresh</p> </li> <li> <p>Instances launched with AMI overrides </p> </li> </ul> <p>This field won't appear for:</p> <ul> <li> <p>Existing instances launched from Launch Templates without overrides</p> </li> <li> <p>Existing instances that didn’t have their root volume replaced through Instance Refresh</p> </li> </ul>"""
    protected_from_scale_in: NotRequired[
        "capo_auto_scaling.types.instance_protected.InstanceProtected"
    ]
    """<p>Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.</p>"""
    weighted_capacity: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len32.XmlStringMaxLen32"
    ]
    """<p>The number of capacity units contributed by the instance based on its instance type.</p> <p>Valid Range: Minimum value of 1. Maximum value of 999.</p>"""

availability_zone instance-attribute

availability_zone: NotRequired[XmlStringMaxLen255]

The Availability Zone in which the instance is running.

availability_zone_id instance-attribute

availability_zone_id: NotRequired[XmlStringMaxLen255]

The Availability Zone ID where the instance was launched.

health_status instance-attribute

health_status: NotRequired[XmlStringMaxLen32]

The last reported health status of the instance. Healthy means that the instance is healthy and should remain in service. Unhealthy means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

image_id instance-attribute

image_id: NotRequired[XmlStringMaxLen255]

The ID of the Amazon Machine Image (AMI) used for the instance's current root volume. This value reflects the most recent AMI applied to the instance, including updates made through root volume replacement operations.

This field appears for:

  • Instances with root volume replacements through Instance Refresh

  • Instances launched with AMI overrides

This field won't appear for:

  • Existing instances launched from Launch Templates without overrides

  • Existing instances that didn’t have their root volume replaced through Instance Refresh

instance_id instance-attribute

instance_id: NotRequired[XmlStringMaxLen19]

The ID of the instance.

instance_type instance-attribute

instance_type: NotRequired[XmlStringMaxLen255]

The instance type of the EC2 instance.

launch_configuration_name instance-attribute

launch_configuration_name: NotRequired[XmlStringMaxLen255]

The launch configuration associated with the instance.

launch_template instance-attribute

launch_template: NotRequired[LaunchTemplateSpecification]

The launch template for the instance.

lifecycle_state instance-attribute

lifecycle_state: NotRequired[LifecycleState]

A description of the current lifecycle state. The Quarantined state is not used. For more information, see Amazon EC2 Auto Scaling instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

protected_from_scale_in instance-attribute

protected_from_scale_in: NotRequired[InstanceProtected]

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

weighted_capacity instance-attribute

weighted_capacity: NotRequired[XmlStringMaxLen32]

The number of capacity units contributed by the instance based on its instance type.

Valid Range: Minimum value of 1. Maximum value of 999.