SetInstanceHealth#

Description#

Changes the health status of the specified instance.

Request Parameters#

Required parameters#

  • HealthStatus — The new health status of the instance.

    • Type: String

    • Required: Yes

    • Valid values: Healthy | Unhealthy

  • InstanceId — The ID of the instance.

    • Type: String

    • Required: Yes

Optional parameters#

  • ShouldRespectGracePeriod — This parameter specifies whether the grace period for the health check should be respected before status is changed.

    • Type: Boolean

    • Required: No

    • Default value: True

Examples#

c2-as SetInstanceHealth InstanceId "i-xxxxxxxx" HealthStatus "Unhealthy"
c2-as SetInstanceHealth InstanceId "i-xxxxxxxx" HealthStatus "Unhealthy" ShouldRespectGracePeriod False