public class UpdateAutoScalingGroupRequest extends AmazonWebServiceRequest implements java.io.Serializable
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.
Constructor and Description |
---|
UpdateAutoScalingGroupRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAutoScalingGroupName()
The name of the Auto Scaling group.
|
java.util.List<java.lang.String> |
getAvailabilityZones()
One or more Availability Zones for the group.
|
java.lang.Integer |
getDefaultCooldown()
The amount of time, in seconds, after a scaling activity completes before
another scaling activity can start.
|
java.lang.Integer |
getDesiredCapacity()
The number of EC2 instances that should be running in the Auto Scaling
group.
|
java.lang.Integer |
getHealthCheckGracePeriod()
The amount of time, in seconds, that Auto Scaling waits before checking
the health status of an EC2 instance that has come into service.
|
java.lang.String |
getHealthCheckType()
The service to use for the health checks.
|
java.lang.String |
getLaunchConfigurationName()
The name of the launch configuration.
|
java.lang.Integer |
getMaxSize()
The maximum size of the Auto Scaling group.
|
java.lang.Integer |
getMinSize()
The minimum size of the Auto Scaling group.
|
java.lang.Boolean |
getNewInstancesProtectedFromScaleIn()
Indicates whether newly launched instances are protected from termination
by Auto Scaling when scaling in.
|
java.lang.String |
getPlacementGroup()
The name of the placement group into which you'll launch your instances,
if any.
|
java.util.List<java.lang.String> |
getTerminationPolicies()
A standalone termination policy or a list of termination policies used to
select the instance to terminate.
|
java.lang.String |
getVPCZoneIdentifier()
The ID of the subnet, if you are launching into a VPC.
|
int |
hashCode() |
java.lang.Boolean |
isNewInstancesProtectedFromScaleIn()
Indicates whether newly launched instances are protected from termination
by Auto Scaling when scaling in.
|
void |
setAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name of the Auto Scaling group.
|
void |
setAvailabilityZones(java.util.Collection<java.lang.String> availabilityZones)
One or more Availability Zones for the group.
|
void |
setDefaultCooldown(java.lang.Integer defaultCooldown)
The amount of time, in seconds, after a scaling activity completes before
another scaling activity can start.
|
void |
setDesiredCapacity(java.lang.Integer desiredCapacity)
The number of EC2 instances that should be running in the Auto Scaling
group.
|
void |
setHealthCheckGracePeriod(java.lang.Integer healthCheckGracePeriod)
The amount of time, in seconds, that Auto Scaling waits before checking
the health status of an EC2 instance that has come into service.
|
void |
setHealthCheckType(java.lang.String healthCheckType)
The service to use for the health checks.
|
void |
setLaunchConfigurationName(java.lang.String launchConfigurationName)
The name of the launch configuration.
|
void |
setMaxSize(java.lang.Integer maxSize)
The maximum size of the Auto Scaling group.
|
void |
setMinSize(java.lang.Integer minSize)
The minimum size of the Auto Scaling group.
|
void |
setNewInstancesProtectedFromScaleIn(java.lang.Boolean newInstancesProtectedFromScaleIn)
Indicates whether newly launched instances are protected from termination
by Auto Scaling when scaling in.
|
void |
setPlacementGroup(java.lang.String placementGroup)
The name of the placement group into which you'll launch your instances,
if any.
|
void |
setTerminationPolicies(java.util.Collection<java.lang.String> terminationPolicies)
A standalone termination policy or a list of termination policies used to
select the instance to terminate.
|
void |
setVPCZoneIdentifier(java.lang.String vPCZoneIdentifier)
The ID of the subnet, if you are launching into a VPC.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
UpdateAutoScalingGroupRequest |
withAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name of the Auto Scaling group.
|
UpdateAutoScalingGroupRequest |
withAvailabilityZones(java.util.Collection<java.lang.String> availabilityZones)
One or more Availability Zones for the group.
|
UpdateAutoScalingGroupRequest |
withAvailabilityZones(java.lang.String... availabilityZones)
One or more Availability Zones for the group.
|
UpdateAutoScalingGroupRequest |
withDefaultCooldown(java.lang.Integer defaultCooldown)
The amount of time, in seconds, after a scaling activity completes before
another scaling activity can start.
|
UpdateAutoScalingGroupRequest |
withDesiredCapacity(java.lang.Integer desiredCapacity)
The number of EC2 instances that should be running in the Auto Scaling
group.
|
UpdateAutoScalingGroupRequest |
withHealthCheckGracePeriod(java.lang.Integer healthCheckGracePeriod)
The amount of time, in seconds, that Auto Scaling waits before checking
the health status of an EC2 instance that has come into service.
|
UpdateAutoScalingGroupRequest |
withHealthCheckType(java.lang.String healthCheckType)
The service to use for the health checks.
|
UpdateAutoScalingGroupRequest |
withLaunchConfigurationName(java.lang.String launchConfigurationName)
The name of the launch configuration.
|
UpdateAutoScalingGroupRequest |
withMaxSize(java.lang.Integer maxSize)
The maximum size of the Auto Scaling group.
|
UpdateAutoScalingGroupRequest |
withMinSize(java.lang.Integer minSize)
The minimum size of the Auto Scaling group.
|
UpdateAutoScalingGroupRequest |
withNewInstancesProtectedFromScaleIn(java.lang.Boolean newInstancesProtectedFromScaleIn)
Indicates whether newly launched instances are protected from termination
by Auto Scaling when scaling in.
|
UpdateAutoScalingGroupRequest |
withPlacementGroup(java.lang.String placementGroup)
The name of the placement group into which you'll launch your instances,
if any.
|
UpdateAutoScalingGroupRequest |
withTerminationPolicies(java.util.Collection<java.lang.String> terminationPolicies)
A standalone termination policy or a list of termination policies used to
select the instance to terminate.
|
UpdateAutoScalingGroupRequest |
withTerminationPolicies(java.lang.String... terminationPolicies)
A standalone termination policy or a list of termination policies used to
select the instance to terminate.
|
UpdateAutoScalingGroupRequest |
withVPCZoneIdentifier(java.lang.String vPCZoneIdentifier)
The ID of the subnet, if you are launching into a VPC.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String getAutoScalingGroupName()
The name of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
The name of the Auto Scaling group.
public void setAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
autoScalingGroupName
- The name of the Auto Scaling group.
public UpdateAutoScalingGroupRequest withAutoScalingGroupName(java.lang.String autoScalingGroupName)
The name of the Auto Scaling 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 Auto Scaling group.
public java.lang.String getLaunchConfigurationName()
The name of the launch configuration.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
The name of the launch configuration.
public void setLaunchConfigurationName(java.lang.String launchConfigurationName)
The name of the launch configuration.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
launchConfigurationName
- The name of the launch configuration.
public UpdateAutoScalingGroupRequest withLaunchConfigurationName(java.lang.String launchConfigurationName)
The name of the launch configuration.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
launchConfigurationName
- The name of the launch configuration.
public java.lang.Integer getMinSize()
The minimum size of the Auto Scaling group.
The minimum size of the Auto Scaling group.
public void setMinSize(java.lang.Integer minSize)
The minimum size of the Auto Scaling group.
minSize
- The minimum size of the Auto Scaling group.
public UpdateAutoScalingGroupRequest withMinSize(java.lang.Integer minSize)
The minimum size of the Auto Scaling group.
Returns a reference to this object so that method calls can be chained together.
minSize
- The minimum size of the Auto Scaling group.
public java.lang.Integer getMaxSize()
The maximum size of the Auto Scaling group.
The maximum size of the Auto Scaling group.
public void setMaxSize(java.lang.Integer maxSize)
The maximum size of the Auto Scaling group.
maxSize
- The maximum size of the Auto Scaling group.
public UpdateAutoScalingGroupRequest withMaxSize(java.lang.Integer maxSize)
The maximum size of the Auto Scaling group.
Returns a reference to this object so that method calls can be chained together.
maxSize
- The maximum size of the Auto Scaling group.
public java.lang.Integer getDesiredCapacity()
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.
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 void setDesiredCapacity(java.lang.Integer 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.
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(java.lang.Integer 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.
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 java.lang.Integer getDefaultCooldown()
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
public void setDefaultCooldown(java.lang.Integer defaultCooldown)
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
defaultCooldown
- The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
public UpdateAutoScalingGroupRequest withDefaultCooldown(java.lang.Integer defaultCooldown)
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
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. The default is 300.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
public java.util.List<java.lang.String> getAvailabilityZones()
One or more Availability Zones for the group.
One or more Availability Zones for the group.
public void setAvailabilityZones(java.util.Collection<java.lang.String> availabilityZones)
One or more Availability Zones for the group.
availabilityZones
- One or more Availability Zones for the group.
public UpdateAutoScalingGroupRequest withAvailabilityZones(java.lang.String... availabilityZones)
One or more Availability Zones for the group.
Returns a reference to this object so that method calls can be chained together.
availabilityZones
- One or more Availability Zones for the group.
public UpdateAutoScalingGroupRequest withAvailabilityZones(java.util.Collection<java.lang.String> availabilityZones)
One or more Availability Zones for the group.
Returns a reference to this object so that method calls can be chained together.
availabilityZones
- One or more Availability Zones for the group.
public java.lang.String getHealthCheckType()
The service to use for the health checks. The valid values are
EC2
and ELB
.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
The service to use for the health checks. The valid values are
EC2
and ELB
.
public void setHealthCheckType(java.lang.String healthCheckType)
The service to use for the health checks. The valid values are
EC2
and ELB
.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
healthCheckType
-
The service to use for the health checks. The valid values are
EC2
and ELB
.
public UpdateAutoScalingGroupRequest withHealthCheckType(java.lang.String healthCheckType)
The service to use for the health checks. The valid values are
EC2
and ELB
.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
healthCheckType
-
The service to use for the health checks. The valid values are
EC2
and ELB
.
public java.lang.Integer getHealthCheckGracePeriod()
The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 300.
For more information, see Health Checks in the Auto Scaling Developer Guide.
The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 300.
For more information, see Health Checks in the Auto Scaling Developer Guide.
public void setHealthCheckGracePeriod(java.lang.Integer healthCheckGracePeriod)
The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 300.
For more information, see Health Checks in the Auto Scaling Developer Guide.
healthCheckGracePeriod
- The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 300.
For more information, see Health Checks in the Auto Scaling Developer Guide.
public UpdateAutoScalingGroupRequest withHealthCheckGracePeriod(java.lang.Integer healthCheckGracePeriod)
The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 300.
For more information, see Health Checks in the Auto Scaling Developer Guide.
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 EC2 instance that has come into service. The default is 300.
For more information, see Health Checks in the Auto Scaling Developer Guide.
public java.lang.String getPlacementGroup()
The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
public void setPlacementGroup(java.lang.String placementGroup)
The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\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 in the Amazon Elastic Compute Cloud User Guide.
public UpdateAutoScalingGroupRequest withPlacementGroup(java.lang.String placementGroup)
The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\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 in the Amazon Elastic Compute Cloud User Guide.
public java.lang.String getVPCZoneIdentifier()
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 Launching Auto Scaling Instances in a VPC in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
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 Launching Auto Scaling Instances in a VPC in the Auto Scaling Developer Guide.
public void setVPCZoneIdentifier(java.lang.String 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 Launching Auto Scaling Instances in a VPC in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\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 Launching Auto Scaling Instances in a VPC in the Auto Scaling Developer Guide.
public UpdateAutoScalingGroupRequest withVPCZoneIdentifier(java.lang.String 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 Launching Auto Scaling Instances in a VPC 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: [ --�𐀀-\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 Launching Auto Scaling Instances in a VPC in the Auto Scaling Developer Guide.
public java.util.List<java.lang.String> getTerminationPolicies()
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 Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling Developer Guide.
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 Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling Developer Guide.
public void setTerminationPolicies(java.util.Collection<java.lang.String> 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 Controlling Which Instances Auto Scaling Terminates During Scale In 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 Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling Developer Guide.
public UpdateAutoScalingGroupRequest withTerminationPolicies(java.lang.String... 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 Controlling Which Instances Auto Scaling Terminates During Scale In 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 Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling Developer Guide.
public UpdateAutoScalingGroupRequest withTerminationPolicies(java.util.Collection<java.lang.String> 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 Controlling Which Instances Auto Scaling Terminates During Scale In 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 Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling Developer Guide.
public java.lang.Boolean isNewInstancesProtectedFromScaleIn()
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
public java.lang.Boolean getNewInstancesProtectedFromScaleIn()
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
public void setNewInstancesProtectedFromScaleIn(java.lang.Boolean newInstancesProtectedFromScaleIn)
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
newInstancesProtectedFromScaleIn
- Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
public UpdateAutoScalingGroupRequest withNewInstancesProtectedFromScaleIn(java.lang.Boolean newInstancesProtectedFromScaleIn)
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
Returns a reference to this object so that method calls can be chained together.
newInstancesProtectedFromScaleIn
- Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
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.