public class UpdateAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable
UpdateAutoScalingGroup operation
.
Updates the configuration for the specified AutoScalingGroup.
NOTE: To update an Auto Scaling group with a launch configuration that has the InstanceMonitoring flag set to False, you must first ensure that collection of group metrics is disabled. Otherwise, calls to UpdateAutoScalingGroup will fail. If you have previously enabled group metrics collection, you can disable collection of all group metrics by calling 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: If a new value is specified for MinSize without specifying the value for DesiredCapacity, and if the new MinSize is larger than the current size of the Auto Scaling Group, there will be an implicit call to SetDesiredCapacity to set the group to the new MinSize. If a new value is specified for MaxSize without specifying the value for DesiredCapacity, and the new MaxSize is smaller than the current size of the Auto Scaling Group, there will be an implicit call to SetDesiredCapacity to set the group to the new MaxSize. All other optional parameters are left unchanged if not passed in the request.
Constructor and Description |
---|
UpdateAutoScalingGroupRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getAutoScalingGroupName()
The name of the Auto Scaling group.
|
List<String> |
getAvailabilityZones()
Availability Zones for the group.
|
Integer |
getDefaultCooldown()
The amount of time, in seconds, after a scaling activity completes
before any further scaling activities can start.
|
Integer |
getDesiredCapacity()
The desired capacity for the Auto Scaling group.
|
Integer |
getHealthCheckGracePeriod()
The length of time that Auto Scaling waits before checking an
instance's health status.
|
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 cluster placement group, if applicable.
|
List<String> |
getTerminationPolicies()
A standalone termination policy or a list of termination policies used
to select the instance to terminate.
|
String |
getVPCZoneIdentifier()
The subnet identifier for the Amazon VPC connection, if applicable.
|
int |
hashCode() |
void |
setAutoScalingGroupName(String autoScalingGroupName)
The name of the Auto Scaling group.
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
Availability Zones for the group.
|
void |
setDefaultCooldown(Integer defaultCooldown)
The amount of time, in seconds, after a scaling activity completes
before any further scaling activities can start.
|
void |
setDesiredCapacity(Integer desiredCapacity)
The desired capacity for the Auto Scaling group.
|
void |
setHealthCheckGracePeriod(Integer healthCheckGracePeriod)
The length of time that Auto Scaling waits before checking an
instance's health status.
|
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 cluster placement group, if applicable.
|
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 subnet identifier for the Amazon VPC connection, if applicable.
|
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)
Availability Zones for the group.
|
UpdateAutoScalingGroupRequest |
withAvailabilityZones(String... availabilityZones)
Availability Zones for the group.
|
UpdateAutoScalingGroupRequest |
withDefaultCooldown(Integer defaultCooldown)
The amount of time, in seconds, after a scaling activity completes
before any further scaling activities can start.
|
UpdateAutoScalingGroupRequest |
withDesiredCapacity(Integer desiredCapacity)
The desired capacity for the Auto Scaling group.
|
UpdateAutoScalingGroupRequest |
withHealthCheckGracePeriod(Integer healthCheckGracePeriod)
The length of time that Auto Scaling waits before checking an
instance's health status.
|
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 cluster placement group, if applicable.
|
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 subnet identifier for the Amazon VPC connection, if applicable.
|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector
public String getAutoScalingGroupName()
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
public void setAutoScalingGroupName(String autoScalingGroupName)
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\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: [ --�𐀀-\r\n\t]*
autoScalingGroupName
- The name of the Auto Scaling group.public String getLaunchConfigurationName()
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
public void setLaunchConfigurationName(String launchConfigurationName)
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\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: [ --�𐀀-\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 desired capacity for the Auto Scaling group.public UpdateAutoScalingGroupRequest withDesiredCapacity(Integer desiredCapacity)
Returns a reference to this object so that method calls can be chained together.
desiredCapacity
- The desired capacity for the Auto Scaling group.public Integer getDefaultCooldown()
public void setDefaultCooldown(Integer defaultCooldown)
defaultCooldown
- The amount of time, in seconds, after a scaling activity completes
before any further scaling activities can start. For more information,
see Cooldown
Period.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 any further scaling activities can start. For more information,
see Cooldown
Period.public List<String> getAvailabilityZones()
Constraints:
Length: 1 -
public void setAvailabilityZones(Collection<String> availabilityZones)
Constraints:
Length: 1 -
availabilityZones
- Availability Zones for the group.public UpdateAutoScalingGroupRequest withAvailabilityZones(String... availabilityZones)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
availabilityZones
- 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
- Availability Zones for the group.public String getHealthCheckType()
EC2
for Amazon EC2 or
ELB
for Elastic Load Balancing.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\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: [ --�𐀀-\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: [ --�𐀀-\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)
healthCheckGracePeriod
- The length of time that Auto Scaling waits before checking an
instance's health status. The grace period begins when an instance
comes into service.public UpdateAutoScalingGroupRequest withHealthCheckGracePeriod(Integer healthCheckGracePeriod)
Returns a reference to this object so that method calls can be chained together.
healthCheckGracePeriod
- The length of time that Auto Scaling waits before checking an
instance's health status. The grace period begins when an instance
comes into service.public String getPlacementGroup()
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
public void setPlacementGroup(String placementGroup)
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
placementGroup
- The name of the cluster placement group, if applicable. For more
information, go to
Using Cluster Instances in the Amazon EC2 User Guide.public UpdateAutoScalingGroupRequest withPlacementGroup(String placementGroup)
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 cluster placement group, if applicable. For more
information, go to
Using Cluster Instances in the Amazon EC2 User Guide.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 on creating your Auto Scaling group in Amazon VPC by specifying subnets, see Launch Auto Scaling Instances into Amazon VPC in the the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\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 on creating your Auto Scaling group in Amazon VPC by specifying subnets, see Launch Auto Scaling Instances into Amazon VPC in the 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 on creating your Auto Scaling group in Amazon VPC by specifying subnets, see Launch Auto Scaling Instances into Amazon VPC in the the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
vPCZoneIdentifier
- The subnet identifier for the Amazon VPC connection, if applicable.
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 on creating your Auto Scaling group in Amazon VPC by specifying subnets, see Launch Auto Scaling Instances into Amazon VPC in the 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 on creating your Auto Scaling group in Amazon VPC by specifying subnets, see Launch Auto Scaling Instances into Amazon VPC in the 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 subnet identifier for the Amazon VPC connection, if applicable.
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 on creating your Auto Scaling group in Amazon VPC by specifying subnets, see Launch Auto Scaling Instances into Amazon VPC in the the Auto Scaling Developer Guide.
public List<String> getTerminationPolicies()
For more information on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
For more information on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
public void setTerminationPolicies(Collection<String> terminationPolicies)
For more information on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the 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 on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
public UpdateAutoScalingGroupRequest withTerminationPolicies(String... terminationPolicies)
For more information on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the 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 on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
public UpdateAutoScalingGroupRequest withTerminationPolicies(Collection<String> terminationPolicies)
For more information on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the 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 on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.