Auto Scaling
API Reference (API Version 2011-01-01)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

SetInstanceHealth

Description

Sets the health status of a specified instance that belongs to any of your Auto Scaling groups.

For more information, see Configure Health Checks for Your Auto Scaling group.

Request Parameters

For information about the common parameters that all actions use, see Common Parameters.

HealthStatus

The health status of the instance. Set to Healthy if you want the instance to remain in service. Set to Unhealthy if you want the instance to be out of service. Auto Scaling will terminate and replace the unhealthy instance.

Type: String

Length constraints: Minimum length of 1. Maximum length of 32.

Required: Yes

InstanceId

The identifier of the Amazon EC2 instance.

Type: String

Length constraints: Minimum length of 1. Maximum length of 16.

Required: Yes

ShouldRespectGracePeriod

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call will respect the grace period. Set this to False, if you do not want the call to respect the grace period associated with the group.

For more information, see the HealthCheckGracePeriod parameter description in the CreateAutoScalingGroup action.

Type: Boolean

Required: No