com.amazonaws.services.autoscaling.model

Class DetachInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.DetachInstancesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DetachInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DetachInstances operation.

Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.

For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Auto Scaling Developer Guide .

See Also:

AmazonAutoScaling.detachInstances(DetachInstancesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DetachInstancesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DetachInstancesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAutoScalingGroupName() The name of the group.
List<String>	getInstanceIds() One or more instance IDs.
Boolean	getShouldDecrementDesiredCapacity() If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.
int	hashCode()
Boolean	isShouldDecrementDesiredCapacity() If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.
void	setAutoScalingGroupName(String autoScalingGroupName) The name of the group.
void	setInstanceIds(Collection<String> instanceIds) One or more instance IDs.
void	setShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity) If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DetachInstancesRequest	withAutoScalingGroupName(String autoScalingGroupName) The name of the group.
DetachInstancesRequest	withInstanceIds(Collection<String> instanceIds) One or more instance IDs.
DetachInstancesRequest	withInstanceIds(String... instanceIds) One or more instance IDs.
DetachInstancesRequest	withShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity) If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

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

DetachInstancesRequest

public DetachInstancesRequest()

Method Detail

getInstanceIds

public List<String> getInstanceIds()

One or more instance IDs.

Returns:

One or more instance IDs.

setInstanceIds

public void setInstanceIds(Collection<String> instanceIds)

One or more instance IDs.

Parameters:

instanceIds - One or more instance IDs.

withInstanceIds

public DetachInstancesRequest withInstanceIds(String... instanceIds)

One or more instance IDs.

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 instance IDs.

Returns:

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

withInstanceIds

public DetachInstancesRequest withInstanceIds(Collection<String> instanceIds)

One or more instance IDs.

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

Parameters:

instanceIds - One or more instance IDs.

Returns:

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

getAutoScalingGroupName

public String getAutoScalingGroupName()

The name of the group.

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

Returns:

The name of the group.

setAutoScalingGroupName

public void setAutoScalingGroupName(String autoScalingGroupName)

The name of the group.

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

Parameters:

autoScalingGroupName - The name of the group.

withAutoScalingGroupName

public DetachInstancesRequest withAutoScalingGroupName(String autoScalingGroupName)

The name of the 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 group.

Returns:

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

isShouldDecrementDesiredCapacity

public Boolean isShouldDecrementDesiredCapacity()

If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Returns:

If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

setShouldDecrementDesiredCapacity

public void setShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity)

If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Parameters:

shouldDecrementDesiredCapacity - If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

withShouldDecrementDesiredCapacity

public DetachInstancesRequest withShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity)

If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

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

Parameters:

shouldDecrementDesiredCapacity - If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Returns:

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

getShouldDecrementDesiredCapacity

public Boolean getShouldDecrementDesiredCapacity()

If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Returns:

If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

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 DetachInstancesRequest 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()