SetInstanceHealth
Sets the health status of the specified instance.
For more information, see Set up a custom health check for your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- HealthStatus
-
The health status of the instance. Set to
Healthy
to have the instance remain in service. Set toUnhealthy
to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes
- InstanceId
-
The ID of the instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 19.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes
- 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 toFalse
, 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.
Type: Boolean
Required: No
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceContention
-
You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of SetInstanceHealth.
Sample Request
https://autoscaling.amazonaws.com/?Action=SetInstanceHealth
&InstanceId=i-1234567890abcdef0
&HealthStatus=Unhealthy
&Version=2011-01-01
&AUTHPARAMS
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: