AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Sets the health status of the specified instance.

For more information, see Health Checks in the Auto Scaling User Guide.

Note:

For PCL 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

C#
public virtual SetInstanceHealthResponse SetInstanceHealth(
         SetInstanceHealthRequest request
)
Parameters
request
Type: Amazon.AutoScaling.Model.SetInstanceHealthRequest

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

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

Exceptions

ExceptionCondition
ResourceContentionException You already have a pending update to an Auto Scaling resource (for example, a 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 response = client.SetInstanceHealth(new SetInstanceHealthRequest 
{
    HealthStatus = "Unhealthy",
    InstanceId = "i-93633f9b"
});


            

Version Information

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also