public class UpdateAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
UpdateAutoScalingGroup operation
.
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group with a launch configuration with
InstanceMonitoring
set to False
,
you must first disable the collection of group metrics.
Otherwise, you will get an error. If you have previously enabled the
collection of group metrics, you can disable it using
DisableMetricsCollection.
The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected.
Note the following:
If you specify a new value for MinSize
without specifying
a value for DesiredCapacity
,
and the new MinSize
is larger than
the current size of the group, we implicitly call SetDesiredCapacity
to set the size of the group to the new value of MinSize
.
If you specify a new value for MaxSize
without specifying
a value for DesiredCapacity
,
and the new MaxSize
is smaller
than the current size of the group, we implicitly call
SetDesiredCapacity to set the size of the group to the new value of
MaxSize
.
All other optional parameters are left unchanged if not specified.
NOOP
Constructor and Description |
---|
UpdateAutoScalingGroupRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateAutoScalingGroupRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getAutoScalingGroupName()
The name of the Auto Scaling group.
|
List<String> |
getAvailabilityZones()
One or more Availability Zones for the group.
|
Integer |
getDefaultCooldown()
The amount of time, in seconds, after a scaling activity completes
before another scaling activity can start.
|
Integer |
getDesiredCapacity()
The number of EC2 instances that should be running in the Auto Scaling
group.
|
Integer |
getHealthCheckGracePeriod()
The amount of time, in seconds, that Auto Scaling waits before
checking the health status of an instance.
|
String |
getHealthCheckType()
The type of health check for the instances in the Auto Scaling group.
|
String |
getLaunchConfigurationName()
The name of the launch configuration.
|
Integer |
getMaxSize()
The maximum size of the Auto Scaling group.
|
Integer |
getMinSize()
The minimum size of the Auto Scaling group.
|
String |
getPlacementGroup()
The name of the placement group into which you'll launch your
instances, if any.
|
List<String> |
getTerminationPolicies()
A standalone termination policy or a list of termination policies used
to select the instance to terminate.
|
String |
getVPCZoneIdentifier()
The ID of the subnet, if you are launching into a VPC.
|
int |
hashCode() |
void |
setAutoScalingGroupName(String autoScalingGroupName)
The name of the Auto Scaling group.
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
One or more Availability Zones for the group.
|
void |
setDefaultCooldown(Integer defaultCooldown)
The amount of time, in seconds, after a scaling activity completes
before another scaling activity can start.
|
void |
setDesiredCapacity(Integer desiredCapacity)
The number of EC2 instances that should be running in the Auto Scaling
group.
|
void |
setHealthCheckGracePeriod(Integer healthCheckGracePeriod)
The amount of time, in seconds, that Auto Scaling waits before
checking the health status of an instance.
|
void |
setHealthCheckType(String healthCheckType)
The type of health check for the instances in the Auto Scaling group.
|
void |
setLaunchConfigurationName(String launchConfigurationName)
The name of the launch configuration.
|
void |
setMaxSize(Integer maxSize)
The maximum size of the Auto Scaling group.
|
void |
setMinSize(Integer minSize)
The minimum size of the Auto Scaling group.
|
void |
setPlacementGroup(String placementGroup)
The name of the placement group into which you'll launch your
instances, if any.
|
void |
setTerminationPolicies(Collection<String> terminationPolicies)
A standalone termination policy or a list of termination policies used
to select the instance to terminate.
|
void |
setVPCZoneIdentifier(String vPCZoneIdentifier)
The ID of the subnet, if you are launching into a VPC.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
UpdateAutoScalingGroupRequest |
withAutoScalingGroupName(String autoScalingGroupName)
The name of the Auto Scaling group.
|
UpdateAutoScalingGroupRequest |
withAvailabilityZones(Collection<String> availabilityZones)
One or more Availability Zones for the group.
|
UpdateAutoScalingGroupRequest |
withAvailabilityZones(String... availabilityZones)
One or more Availability Zones for the group.
|
UpdateAutoScalingGroupRequest |
withDefaultCooldown(Integer defaultCooldown)
The amount of time, in seconds, after a scaling activity completes
before another scaling activity can start.
|
UpdateAutoScalingGroupRequest |
withDesiredCapacity(Integer desiredCapacity)
The number of EC2 instances that should be running in the Auto Scaling
group.
|
UpdateAutoScalingGroupRequest |
withHealthCheckGracePeriod(Integer healthCheckGracePeriod)
The amount of time, in seconds, that Auto Scaling waits before
checking the health status of an instance.
|
UpdateAutoScalingGroupRequest |
withHealthCheckType(String healthCheckType)
The type of health check for the instances in the Auto Scaling group.
|
UpdateAutoScalingGroupRequest |
withLaunchConfigurationName(String launchConfigurationName)
The name of the launch configuration.
|
UpdateAutoScalingGroupRequest |
withMaxSize(Integer maxSize)
The maximum size of the Auto Scaling group.
|
UpdateAutoScalingGroupRequest |
withMinSize(Integer minSize)
The minimum size of the Auto Scaling group.
|
UpdateAutoScalingGroupRequest |
withPlacementGroup(String placementGroup)
The name of the placement group into which you'll launch your
instances, if any.
|
UpdateAutoScalingGroupRequest |
withTerminationPolicies(Collection<String> terminationPolicies)
A standalone termination policy or a list of termination policies used
to select the instance to terminate.
|
UpdateAutoScalingGroupRequest |
withTerminationPolicies(String... terminationPolicies)
A standalone termination policy or a list of termination policies used
to select the instance to terminate.
|
UpdateAutoScalingGroupRequest |
withVPCZoneIdentifier(String vPCZoneIdentifier)
The ID of the subnet, if you are launching into a VPC.
|
copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
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.public UpdateAutoScalingGroupRequest 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.public String getLaunchConfigurationName()
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
public void setLaunchConfigurationName(String launchConfigurationName)
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
launchConfigurationName
- The name of the launch configuration.public UpdateAutoScalingGroupRequest withLaunchConfigurationName(String launchConfigurationName)
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]*
launchConfigurationName
- The name of the launch configuration.public Integer getMinSize()
public void setMinSize(Integer minSize)
minSize
- The minimum size of the Auto Scaling group.public UpdateAutoScalingGroupRequest withMinSize(Integer minSize)
Returns a reference to this object so that method calls can be chained together.
minSize
- The minimum size of the Auto Scaling group.public Integer getMaxSize()
public void setMaxSize(Integer maxSize)
maxSize
- The maximum size of the Auto Scaling group.public UpdateAutoScalingGroupRequest withMaxSize(Integer maxSize)
Returns a reference to this object so that method calls can be chained together.
maxSize
- The maximum size of the Auto Scaling group.public Integer getDesiredCapacity()
public void setDesiredCapacity(Integer desiredCapacity)
desiredCapacity
- The number of EC2 instances that should be running in the Auto Scaling
group. This number must be greater than or equal to the minimum size
of the group and less than or equal to the maximum size of the group.public UpdateAutoScalingGroupRequest withDesiredCapacity(Integer desiredCapacity)
Returns a reference to this object so that method calls can be chained together.
desiredCapacity
- The number of EC2 instances that should be running in the Auto Scaling
group. This number must be greater than or equal to the minimum size
of the group and less than or equal to the maximum size of the group.public Integer getDefaultCooldown()
public void setDefaultCooldown(Integer defaultCooldown)
defaultCooldown
- The amount of time, in seconds, after a scaling activity completes
before another scaling activity can start. For more information, see
Understanding
Auto Scaling Cooldowns.public UpdateAutoScalingGroupRequest withDefaultCooldown(Integer defaultCooldown)
Returns a reference to this object so that method calls can be chained together.
defaultCooldown
- The amount of time, in seconds, after a scaling activity completes
before another scaling activity can start. For more information, see
Understanding
Auto Scaling Cooldowns.public List<String> getAvailabilityZones()
Constraints:
Length: 1 -
public void setAvailabilityZones(Collection<String> availabilityZones)
Constraints:
Length: 1 -
availabilityZones
- One or more Availability Zones for the group.public UpdateAutoScalingGroupRequest withAvailabilityZones(String... availabilityZones)
NOTE: This method appends the values to the existing list (if
any). Use setAvailabilityZones(java.util.Collection)
or
withAvailabilityZones(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.
Constraints:
Length: 1 -
availabilityZones
- One or more Availability Zones for the group.public UpdateAutoScalingGroupRequest withAvailabilityZones(Collection<String> availabilityZones)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
availabilityZones
- One or more Availability Zones for the group.public String getHealthCheckType()
EC2
for Amazon EC2 or
ELB
for Elastic Load Balancing.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
EC2
for Amazon EC2 or
ELB
for Elastic Load Balancing.public void setHealthCheckType(String healthCheckType)
EC2
for Amazon EC2 or
ELB
for Elastic Load Balancing.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
healthCheckType
- The type of health check for the instances in the Auto Scaling group.
The health check type can either be EC2
for Amazon EC2 or
ELB
for Elastic Load Balancing.public UpdateAutoScalingGroupRequest withHealthCheckType(String healthCheckType)
EC2
for Amazon EC2 or
ELB
for Elastic Load Balancing.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
healthCheckType
- The type of health check for the instances in the Auto Scaling group.
The health check type can either be EC2
for Amazon EC2 or
ELB
for Elastic Load Balancing.public Integer getHealthCheckGracePeriod()
public void setHealthCheckGracePeriod(Integer healthCheckGracePeriod)
public UpdateAutoScalingGroupRequest withHealthCheckGracePeriod(Integer healthCheckGracePeriod)
Returns a reference to this object so that method calls can be chained together.
healthCheckGracePeriod
- The amount of time, in seconds, that Auto Scaling waits before
checking the health status of an instance. The grace period begins
when the instance passes the system status and instance status checks
from Amazon EC2. For more information, see .public String getPlacementGroup()
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
public void setPlacementGroup(String placementGroup)
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
placementGroup
- The name of the placement group into which you'll launch your
instances, if any. For more information, see Placement
Groups.public UpdateAutoScalingGroupRequest withPlacementGroup(String placementGroup)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
placementGroup
- The name of the placement group into which you'll launch your
instances, if any. For more information, see Placement
Groups.public String getVPCZoneIdentifier()
When you specify
VPCZoneIdentifier
with AvailabilityZones
,
ensure that the subnets' Availability Zones match the values you
specify for AvailabilityZones
.
For more information, see Auto Scaling and Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
When you specify
VPCZoneIdentifier
with AvailabilityZones
,
ensure that the subnets' Availability Zones match the values you
specify for AvailabilityZones
.
For more information, see Auto Scaling and Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
public void setVPCZoneIdentifier(String vPCZoneIdentifier)
When you specify
VPCZoneIdentifier
with AvailabilityZones
,
ensure that the subnets' Availability Zones match the values you
specify for AvailabilityZones
.
For more information, see Auto Scaling and Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
vPCZoneIdentifier
- The ID of the subnet, if you are launching into a VPC. You can specify
several subnets in a comma-separated list. When you specify
VPCZoneIdentifier
with AvailabilityZones
,
ensure that the subnets' Availability Zones match the values you
specify for AvailabilityZones
.
For more information, see Auto Scaling and Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
public UpdateAutoScalingGroupRequest withVPCZoneIdentifier(String vPCZoneIdentifier)
When you specify
VPCZoneIdentifier
with AvailabilityZones
,
ensure that the subnets' Availability Zones match the values you
specify for AvailabilityZones
.
For more information, see Auto Scaling and Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
vPCZoneIdentifier
- The ID of the subnet, if you are launching into a VPC. You can specify
several subnets in a comma-separated list. When you specify
VPCZoneIdentifier
with AvailabilityZones
,
ensure that the subnets' Availability Zones match the values you
specify for AvailabilityZones
.
For more information, see Auto Scaling and Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
public List<String> getTerminationPolicies()
For more information, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
For more information, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
public void setTerminationPolicies(Collection<String> terminationPolicies)
For more information, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
terminationPolicies
- A standalone termination policy or a list of termination policies used
to select the instance to terminate. The policies are executed in the
order that they are listed. For more information, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
public UpdateAutoScalingGroupRequest withTerminationPolicies(String... terminationPolicies)
For more information, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
NOTE: This method appends the values to the existing list (if
any). Use setTerminationPolicies(java.util.Collection)
or
withTerminationPolicies(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.
terminationPolicies
- A standalone termination policy or a list of termination policies used
to select the instance to terminate. The policies are executed in the
order that they are listed. For more information, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
public UpdateAutoScalingGroupRequest withTerminationPolicies(Collection<String> terminationPolicies)
For more information, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
Returns a reference to this object so that method calls can be chained together.
terminationPolicies
- A standalone termination policy or a list of termination policies used
to select the instance to terminate. The policies are executed in the
order that they are listed. For more information, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
public String toString()
toString
in class Object
Object.toString()
public UpdateAutoScalingGroupRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2015. All rights reserved.