IAmazonAutoScaling.SetInstanceHealth Method (SetInstanceHealthRequest)

Sets the health status of the specified instance.

For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to SetInstanceHealthAsync.

Namespace: Amazon.AutoScaling
Assembly: AWSSDK.AutoScaling.dll
Version: 3.x.y.z

Syntax

public abstract SetInstanceHealthResponse SetInstanceHealth(
         SetInstanceHealthRequest request
)

Parameters

request: Type: Amazon.AutoScaling.Model.SetInstanceHealthRequest

Container for the necessary parameters to execute the SetInstanceHealth service method.

Return Value

Type: SetInstanceHealthResponse

The response from the SetInstanceHealth service method, as returned by AutoScaling.

Exceptions

Exception	Condition
ResourceContentionException	You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

Examples

This example sets the health status of the specified instance to Unhealthy.

To set the health status of an instance


var client = new AmazonAutoScalingClient();
var response = client.SetInstanceHealth(new SetInstanceHealthRequest 
{
    HealthStatus = "Unhealthy",
    InstanceId = "i-93633f9b"
});

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

IAmazonAutoScaling.SetInstanceHealth (SetInstanceHealthRequest)

Method