SetInstanceHealthRequest Class | AWS SDK for .NET V3

Container for the parameters to the SetInstanceHealth operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AutoScaling.AmazonAutoScalingRequest
      Amazon.AutoScaling.Model.SetInstanceHealthRequest

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

Syntax

public class SetInstanceHealthRequest : AmazonAutoScalingRequest
         IAmazonWebServiceRequest

The SetInstanceHealthRequest type exposes the following members

Constructors

	Name	Description
	SetInstanceHealthRequest()

Properties

Name Type Description

Name	Type	Description
HealthStatus	System.String	Gets and sets the property HealthStatus. The health status of the instance. Set to `Healthy` to have the instance remain in service. Set to `Unhealthy` to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.
InstanceId	System.String	Gets and sets the property InstanceId. The ID of the instance.
ShouldRespectGracePeriod	System.Boolean	Gets and sets the property 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 to `False`, 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.

HealthStatus

System.String

Gets and sets the property HealthStatus.

The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

InstanceId

System.String

Gets and sets the property InstanceId.

The ID of the instance.

ShouldRespectGracePeriod

System.Boolean

Gets and sets the property 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 to False, 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.

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:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5