com.amazonaws.services.autoscaling.model

Class DetachInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.DetachInstancesRequest

All Implemented Interfaces:

Serializable

public class DetachInstancesRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DetachInstances operation.

Using DetachInstances , you can remove an instance from an Auto Scaling group. After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.

To learn more about detaching instances, see Detach Amazon EC2 Instances From Your Auto Scaling Group .

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
boolean	equals(Object obj)
String	getAutoScalingGroupName() The name of the Auto Scaling group from which to detach instances.
List<String>	getInstanceIds() A list of instances to detach from the Auto Scaling group.
Boolean	getShouldDecrementDesiredCapacity() Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group.
int	hashCode()
Boolean	isShouldDecrementDesiredCapacity() Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group.
void	setAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group from which to detach instances.
void	setInstanceIds(Collection<String> instanceIds) A list of instances to detach from the Auto Scaling group.
void	setShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity) Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DetachInstancesRequest	withAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group from which to detach instances.
DetachInstancesRequest	withInstanceIds(Collection<String> instanceIds) A list of instances to detach from the Auto Scaling group.
DetachInstancesRequest	withInstanceIds(String... instanceIds) A list of instances to detach from the Auto Scaling group.
DetachInstancesRequest	withShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity) Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DetachInstancesRequest

public DetachInstancesRequest()

Method Detail

getInstanceIds

public List<String> getInstanceIds()

A list of instances to detach from the Auto Scaling group. You must specify at least one instance ID.

Returns:

A list of instances to detach from the Auto Scaling group. You must specify at least one instance ID.

setInstanceIds

public void setInstanceIds(Collection<String> instanceIds)

A list of instances to detach from the Auto Scaling group. You must specify at least one instance ID.

Parameters:

instanceIds - A list of instances to detach from the Auto Scaling group. You must specify at least one instance ID.

withInstanceIds

public DetachInstancesRequest withInstanceIds(String... instanceIds)

A list of instances to detach from the Auto Scaling group. You must specify at least one instance ID.

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

Parameters:

instanceIds - A list of instances to detach from the Auto Scaling group. 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 DetachInstancesRequest withInstanceIds(Collection<String> instanceIds)

A list of instances to detach from the Auto Scaling group. You must specify at least one instance ID.

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

Parameters:

instanceIds - A list of instances to detach from the Auto Scaling group. 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 from which to detach instances.

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

Returns:

The name of the Auto Scaling group from which to detach instances.

setAutoScalingGroupName

public void setAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group from which to detach instances.

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 from which to detach instances.

withAutoScalingGroupName

public DetachInstancesRequest withAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group from which to detach instances.

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 from which to detach instances.

Returns:

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

isShouldDecrementDesiredCapacity

public Boolean isShouldDecrementDesiredCapacity()

Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group. If set to True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Returns:

Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group. If set to True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

setShouldDecrementDesiredCapacity

public void setShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity)

Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group. If set to True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Parameters:

shouldDecrementDesiredCapacity - Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group. If set to True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

withShouldDecrementDesiredCapacity

public DetachInstancesRequest withShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity)

Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group. If set to 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 - Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group. If set to 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()

Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group. If set to True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Returns:

Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group. If set to 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