public class DetachInstancesRequest extends AmazonWebServiceRequest implements Serializable
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 .
NOOP| Constructor and Description |
|---|
DetachInstancesRequest() |
| 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.
|
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic List<String> getInstanceIds()
public void setInstanceIds(Collection<String> instanceIds)
instanceIds - A list of instances to detach from the Auto Scaling group. You must
specify at least one instance ID.public DetachInstancesRequest withInstanceIds(String... instanceIds)
Returns a reference to this object so that method calls can be chained together.
instanceIds - A list of instances to detach from the Auto Scaling group. You must
specify at least one instance ID.public DetachInstancesRequest withInstanceIds(Collection<String> instanceIds)
Returns a reference to this object so that method calls can be chained together.
instanceIds - A list of instances to detach from the Auto Scaling group. You must
specify at least one instance ID.public String getAutoScalingGroupName()
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
public void setAutoScalingGroupName(String autoScalingGroupName)
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
autoScalingGroupName - The name of the Auto Scaling group from which to detach instances.public DetachInstancesRequest withAutoScalingGroupName(String autoScalingGroupName)
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]*
autoScalingGroupName - The name of the Auto Scaling group from which to detach instances.public Boolean isShouldDecrementDesiredCapacity()
True, the Auto Scaling group decrements the desired
capacity value by the number of instances detached.True, the Auto Scaling group decrements the desired
capacity value by the number of instances detached.public void setShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity)
True, the Auto Scaling group decrements the desired
capacity value by the number of instances detached.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.public DetachInstancesRequest withShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity)
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.
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.public Boolean getShouldDecrementDesiredCapacity()
True, the Auto Scaling group decrements the desired
capacity value by the number of instances detached.True, the Auto Scaling group decrements the desired
capacity value by the number of instances detached.public String toString()
toString in class ObjectObject.toString()Copyright © 2014. All rights reserved.