com.amazonaws.services.autoscaling.model

Class EnterStandbyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.EnterStandbyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class EnterStandbyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the EnterStandby operation.

Moves the specified instances into Standby mode.

For more information, see Auto Scaling InService State in the Auto Scaling Developer Guide .

See Also:

AmazonAutoScaling.enterStandby(EnterStandbyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
EnterStandbyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
EnterStandbyRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAutoScalingGroupName() The name of the Auto Scaling group.
List<String>	getInstanceIds() One or more instances to move into Standby mode.
Boolean	getShouldDecrementDesiredCapacity() Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity.
int	hashCode()
Boolean	isShouldDecrementDesiredCapacity() Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity.
void	setAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
void	setInstanceIds(Collection<String> instanceIds) One or more instances to move into Standby mode.
void	setShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity) Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity.
String	toString() Returns a string representation of this object; useful for testing and debugging.
EnterStandbyRequest	withAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
EnterStandbyRequest	withInstanceIds(Collection<String> instanceIds) One or more instances to move into Standby mode.
EnterStandbyRequest	withInstanceIds(String... instanceIds) One or more instances to move into Standby mode.
EnterStandbyRequest	withShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity) Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

EnterStandbyRequest

public EnterStandbyRequest()

Method Detail

getInstanceIds

public List<String> getInstanceIds()

One or more instances to move into Standby mode. You must specify at least one instance ID.

Returns:

One or more instances to move into Standby mode. You must specify at least one instance ID.

setInstanceIds

public void setInstanceIds(Collection<String> instanceIds)

One or more instances to move into Standby mode. You must specify at least one instance ID.

Parameters:

instanceIds - One or more instances to move into Standby mode. You must specify at least one instance ID.

withInstanceIds

public EnterStandbyRequest withInstanceIds(String... instanceIds)

One or more instances to move into Standby mode. You must specify at least one instance ID.

NOTE: This method appends the values to the existing list (if any). Use setInstanceIds(java.util.Collection) or withInstanceIds(java.util.Collection) if you want to override the existing values.

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

Parameters:

instanceIds - One or more instances to move into Standby mode. You must specify at least one instance ID.

Returns:

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

withInstanceIds

public EnterStandbyRequest withInstanceIds(Collection<String> instanceIds)

One or more instances to move into Standby mode. You must specify at least one instance ID.

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

Parameters:

instanceIds - One or more instances to move into Standby mode. You must specify at least one instance ID.

Returns:

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

getAutoScalingGroupName

public String getAutoScalingGroupName()

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The name of the Auto Scaling group.

setAutoScalingGroupName

public void setAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

withAutoScalingGroupName

public EnterStandbyRequest withAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

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

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

Returns:

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

isShouldDecrementDesiredCapacity

public Boolean isShouldDecrementDesiredCapacity()

Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.

Returns:

Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.

setShouldDecrementDesiredCapacity

public void setShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity)

Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.

Parameters:

shouldDecrementDesiredCapacity - Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.

withShouldDecrementDesiredCapacity

public EnterStandbyRequest withShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity)

Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.

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

Parameters:

shouldDecrementDesiredCapacity - Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.

Returns:

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

getShouldDecrementDesiredCapacity

public Boolean getShouldDecrementDesiredCapacity()

Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.

Returns:

Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.

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

clone

public EnterStandbyRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()