Skip to content

AutoScalingInstanceDetails

Source code in docs_src/capo_auto_scaling/types/auto_scaling_instance_details.py
class AutoScalingInstanceDetails(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>"""
    auto_scaling_group_name: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The name of the Auto Scaling group for the instance.</p>"""
    availability_zone: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The Availability Zone for the instance.</p>"""
    availability_zone_id: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p> The Availability Zone ID where the instance is located. </p>"""
    lifecycle_state: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len32.XmlStringMaxLen32"
    ]
    """<p>The lifecycle state for the instance. 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> <p>Valid values: <code>Pending</code> | <code>Pending:Wait</code> | <code>Pending:Proceed</code> | <code>Quarantined</code> | <code>InService</code> | <code>Terminating</code> | <code>Terminating:Wait</code> | <code>Terminating:Proceed</code> | <code>Terminating:Retained</code> | <code>Terminated</code> | <code>Detaching</code> | <code>Detached</code> | <code>EnteringStandby</code> | <code>Standby</code> | <code>ReplacingRootVolume</code> | <code>ReplacingRootVolume:Wait</code> | <code>ReplacingRootVolume:Proceed</code> | <code>RootVolumeReplaced</code> | <code>Warmed:Pending</code> | <code>Warmed:Pending:Wait</code> | <code>Warmed:Pending:Proceed</code> | <code>Warmed:Pending:Retained</code> | <code>Warmed:Terminating</code> | <code>Warmed:Terminating:Wait</code> | <code>Warmed:Terminating:Proceed</code> | <code>Warmed:Terminating:Retained</code> | <code>Warmed:Terminated</code> | <code>Warmed:Stopped</code> | <code>Warmed:Running</code> | <code>Warmed:Hibernated</code> </p>"""
    health_status: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len32.XmlStringMaxLen32"
    ]
    """<p>The last reported health status of this 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 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 used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.</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) associated with the instance. This field shows the current AMI ID of the instance's root volume. It may differ from the original AMI used when the instance was first launched. </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>"""

auto_scaling_group_name instance-attribute

auto_scaling_group_name: NotRequired[XmlStringMaxLen255]

The name of the Auto Scaling group for the instance.

availability_zone instance-attribute

availability_zone: NotRequired[XmlStringMaxLen255]

The Availability Zone for the instance.

availability_zone_id instance-attribute

availability_zone_id: NotRequired[XmlStringMaxLen255]

The Availability Zone ID where the instance is located.

health_status instance-attribute

health_status: NotRequired[XmlStringMaxLen32]

The last reported health status of this instance. Healthy means that the instance is healthy and should remain in service. Unhealthy means that the instance is unhealthy and 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) associated with the instance. This field shows the current AMI ID of the instance's root volume. It may differ from the original AMI used when the instance was first launched.

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 used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.

launch_template instance-attribute

launch_template: NotRequired[LaunchTemplateSpecification]

The launch template for the instance.

lifecycle_state instance-attribute

lifecycle_state: NotRequired[XmlStringMaxLen32]

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

Valid values: Pending | Pending:Wait | Pending:Proceed | Quarantined | InService | Terminating | Terminating:Wait | Terminating:Proceed | Terminating:Retained | Terminated | Detaching | Detached | EnteringStandby | Standby | ReplacingRootVolume | ReplacingRootVolume:Wait | ReplacingRootVolume:Proceed | RootVolumeReplaced | Warmed:Pending | Warmed:Pending:Wait | Warmed:Pending:Proceed | Warmed:Pending:Retained | Warmed:Terminating | Warmed:Terminating:Wait | Warmed:Terminating:Proceed | Warmed:Terminating:Retained | Warmed:Terminated | Warmed:Stopped | Warmed:Running | Warmed:Hibernated

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.