com.amazonaws.services.autoscaling.model

Class SetInstanceHealthRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.SetInstanceHealthRequest

All Implemented Interfaces:

Serializable

public class SetInstanceHealthRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the SetInstanceHealth operation.

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 .

See Also:

AmazonAutoScaling.setInstanceHealth(SetInstanceHealthRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetInstanceHealthRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getHealthStatus() The health status of the instance.
String	getInstanceId() The identifier of the Amazon EC2 instance.
Boolean	getShouldRespectGracePeriod() 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.
int	hashCode()
Boolean	isShouldRespectGracePeriod() 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.
void	setHealthStatus(String healthStatus) The health status of the instance.
void	setInstanceId(String instanceId) The identifier of the Amazon EC2 instance.
void	setShouldRespectGracePeriod(Boolean 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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SetInstanceHealthRequest	withHealthStatus(String healthStatus) The health status of the instance.
SetInstanceHealthRequest	withInstanceId(String instanceId) The identifier of the Amazon EC2 instance.
SetInstanceHealthRequest	withShouldRespectGracePeriod(Boolean 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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

SetInstanceHealthRequest

public SetInstanceHealthRequest()

Method Detail

getInstanceId

public String getInstanceId()

The identifier of the Amazon EC2 instance.

Constraints:
Length: 1 - 16
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

The identifier of the Amazon EC2 instance.

setInstanceId

public void setInstanceId(String instanceId)

The identifier of the Amazon EC2 instance.

Constraints:
Length: 1 - 16
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

instanceId - The identifier of the Amazon EC2 instance.

withInstanceId

public SetInstanceHealthRequest withInstanceId(String instanceId)

The identifier of the Amazon EC2 instance.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 16
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

instanceId - The identifier of the Amazon EC2 instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getHealthStatus

public String getHealthStatus()

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.

Constraints:
Length: 1 - 32
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

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.

setHealthStatus

public void setHealthStatus(String 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.

Constraints:
Length: 1 - 32
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

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.

withHealthStatus

public SetInstanceHealthRequest withHealthStatus(String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 32
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

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.

Returns:

A reference to this updated object so that method calls can be chained together.

isShouldRespectGracePeriod

public Boolean isShouldRespectGracePeriod()

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.

Returns:

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.

setShouldRespectGracePeriod

public void setShouldRespectGracePeriod(Boolean 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.

Parameters:

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.

withShouldRespectGracePeriod

public SetInstanceHealthRequest withShouldRespectGracePeriod(Boolean 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getShouldRespectGracePeriod

public Boolean getShouldRespectGracePeriod()

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.

Returns:

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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object