public class DetachInstancesRequest extends AmazonWebServiceRequest implements java.io.Serializable
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.
If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.
For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Auto Scaling Developer Guide.
Constructor and Description |
---|
DetachInstancesRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAutoScalingGroupName()
The name of the group.
|
java.util.List<java.lang.String> |
getInstanceIds()
One or more instance IDs.
|
java.lang.Boolean |
getShouldDecrementDesiredCapacity()
If
True , the Auto Scaling group decrements the desired
capacity value by the number of instances detached. |
int |
hashCode() |
java.lang.Boolean |
isShouldDecrementDesiredCapacity()
If
True , the Auto Scaling group decrements the desired
capacity value by the number of instances detached. |
void |
setAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name of the group.
|
void |
setInstanceIds(java.util.Collection<java.lang.String> instanceIds)
One or more instance IDs.
|
void |
setShouldDecrementDesiredCapacity(java.lang.Boolean shouldDecrementDesiredCapacity)
If
True , the Auto Scaling group decrements the desired
capacity value by the number of instances detached. |
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DetachInstancesRequest |
withAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name of the group.
|
DetachInstancesRequest |
withInstanceIds(java.util.Collection<java.lang.String> instanceIds)
One or more instance IDs.
|
DetachInstancesRequest |
withInstanceIds(java.lang.String... instanceIds)
One or more instance IDs.
|
DetachInstancesRequest |
withShouldDecrementDesiredCapacity(java.lang.Boolean shouldDecrementDesiredCapacity)
If
True , the Auto Scaling group decrements the desired
capacity value by the number of instances detached. |
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.util.List<java.lang.String> getInstanceIds()
One or more instance IDs.
One or more instance IDs.
public void setInstanceIds(java.util.Collection<java.lang.String> instanceIds)
One or more instance IDs.
instanceIds
- One or more instance IDs.
public DetachInstancesRequest withInstanceIds(java.lang.String... instanceIds)
One or more instance IDs.
Returns a reference to this object so that method calls can be chained together.
instanceIds
- One or more instance IDs.
public DetachInstancesRequest withInstanceIds(java.util.Collection<java.lang.String> instanceIds)
One or more instance IDs.
Returns a reference to this object so that method calls can be chained together.
instanceIds
- One or more instance IDs.
public java.lang.String getAutoScalingGroupName()
The name of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
The name of the group.
public void setAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
autoScalingGroupName
- The name of the group.
public DetachInstancesRequest withAutoScalingGroupName(java.lang.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: [ --�𐀀-\r\n\t]*
autoScalingGroupName
- The name of the group.
public java.lang.Boolean isShouldDecrementDesiredCapacity()
If True
, the Auto Scaling group decrements the desired
capacity value by the number of instances detached.
If True
, the Auto Scaling group decrements the
desired capacity value by the number of instances detached.
public java.lang.Boolean getShouldDecrementDesiredCapacity()
If True
, the Auto Scaling group decrements the desired
capacity value by the number of instances detached.
If True
, the Auto Scaling group decrements the
desired capacity value by the number of instances detached.
public void setShouldDecrementDesiredCapacity(java.lang.Boolean shouldDecrementDesiredCapacity)
If True
, the Auto Scaling group decrements the desired
capacity value by the number of instances detached.
shouldDecrementDesiredCapacity
-
If True
, the Auto Scaling group decrements the
desired capacity value by the number of instances detached.
public DetachInstancesRequest withShouldDecrementDesiredCapacity(java.lang.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.
shouldDecrementDesiredCapacity
-
If True
, the Auto Scaling group decrements the
desired capacity value by the number of instances detached.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.