Skip to content

SetInstanceHealthQuery

Source code in docs_src/capo_auto_scaling/types/set_instance_health_query.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class SetInstanceHealthQuery(TypedDict, closed=True):
    instance_id: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len19.XmlStringMaxLen19"
    ]
    """<p>The ID of the instance.</p>"""
    health_status: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len32.XmlStringMaxLen32"
    ]
    """<p>The health status of the instance. Set to <code>Healthy</code> to have the instance remain in service. Set to <code>Unhealthy</code> to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.</p>"""
    should_respect_grace_period: NotRequired[
        "capo_auto_scaling.types.should_respect_grace_period.ShouldRespectGracePeriod"
    ]
    """<p>If the Auto Scaling group of the specified instance has a <code>HealthCheckGracePeriod</code> specified for the group, by default, this call respects the grace period. Set this to <code>False</code>, to have the call not respect the grace period associated with the group.</p> <p>For more information about the health check grace period, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html">Set the health check grace period for an Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"""

health_status instance-attribute 

health_status: NotRequired[XmlStringMaxLen32]

The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

instance_id instance-attribute 

instance_id: NotRequired[XmlStringMaxLen19]

The ID of the instance.

should_respect_grace_period instance-attribute 

should_respect_grace_period: NotRequired[ShouldRespectGracePeriod]

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False, to have the call not respect the grace period associated with the group.

For more information about the health check grace period, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.