Package software.amazon.awssdk.services.autoscaling.model

Class SetInstanceHealthRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest

software.amazon.awssdk.services.autoscaling.model.SetInstanceHealthRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SetInstanceHealthRequest.Builder,SetInstanceHealthRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SetInstanceHealthRequest
extends AutoScalingRequest
implements ToCopyableBuilder<SetInstanceHealthRequest.Builder,SetInstanceHealthRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SetInstanceHealthRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SetInstanceHealthRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	healthStatus()	The health status of the instance.
String	instanceId()	The ID of the instance.
List<SdkField<?>>	sdkFields()
static Class<? extends SetInstanceHealthRequest.Builder>	serializableBuilderClass()
Boolean	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.
SetInstanceHealthRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

instanceId

public final String instanceId()

The ID of the instance.

Returns:

The ID of the instance.

healthStatus

public final String 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.

Returns:

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.

shouldRespectGracePeriod

public final Boolean 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 CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API Reference.

Returns:

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 CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API Reference.

toBuilder

public SetInstanceHealthRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SetInstanceHealthRequest.Builder,SetInstanceHealthRequest>

Specified by:

toBuilder in class AutoScalingRequest

builder

public static SetInstanceHealthRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SetInstanceHealthRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo