com.amazonaws.services.autoscaling.model
Class UpdateAutoScalingGroupRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.autoscaling.model.UpdateAutoScalingGroupRequest

public class UpdateAutoScalingGroupRequest
extends AmazonWebServiceRequest

Container for the parameters to the 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. Triggers 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.

See Also:

AmazonAutoScaling.updateAutoScalingGroup(UpdateAutoScalingGroupRequest)

Constructor Summary

UpdateAutoScalingGroupRequest()

Method Summary

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 trigger-related 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 service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.
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 trigger-related 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 service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.
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 trigger-related 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 service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, setDelegationToken, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateAutoScalingGroupRequest

public UpdateAutoScalingGroupRequest()

Method Detail

getAutoScalingGroupName

public String getAutoScalingGroupName()

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

The name of the Auto Scaling group.

setAutoScalingGroupName

public void setAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

withAutoScalingGroupName

public UpdateAutoScalingGroupRequest withAutoScalingGroupName(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]*

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

Returns:

A reference to this updated object so that method calls can be chained together.

getLaunchConfigurationName

public String getLaunchConfigurationName()

The name of the launch configuration.

Constraints:
Length: 1 - 1600
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

The name of the launch configuration.

setLaunchConfigurationName

public void setLaunchConfigurationName(String launchConfigurationName)

The name of the launch configuration.

Constraints:
Length: 1 - 1600
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

launchConfigurationName - The name of the launch configuration.

withLaunchConfigurationName

public UpdateAutoScalingGroupRequest withLaunchConfigurationName(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]*

Parameters:

launchConfigurationName - The name of the launch configuration.

Returns:

A reference to this updated object so that method calls can be chained together.

getMinSize

public Integer getMinSize()

The minimum size of the Auto Scaling group.

Returns:

The minimum size of the Auto Scaling group.

setMinSize

public void setMinSize(Integer minSize)

The minimum size of the Auto Scaling group.

Parameters:

minSize - The minimum size of the Auto Scaling group.

withMinSize

public UpdateAutoScalingGroupRequest withMinSize(Integer minSize)

The minimum size of the Auto Scaling group.

Returns a reference to this object so that method calls can be chained together.

Parameters:

minSize - The minimum size of the Auto Scaling group.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxSize

public Integer getMaxSize()

The maximum size of the Auto Scaling group.

Returns:

The maximum size of the Auto Scaling group.

setMaxSize

public void setMaxSize(Integer maxSize)

The maximum size of the Auto Scaling group.

Parameters:

maxSize - The maximum size of the Auto Scaling group.

withMaxSize

public UpdateAutoScalingGroupRequest withMaxSize(Integer maxSize)

The maximum size of the Auto Scaling group.

Returns a reference to this object so that method calls can be chained together.

Parameters:

maxSize - The maximum size of the Auto Scaling group.

Returns:

A reference to this updated object so that method calls can be chained together.

getDesiredCapacity

public Integer getDesiredCapacity()

The desired capacity for the Auto Scaling group.

Returns:

The desired capacity for the Auto Scaling group.

setDesiredCapacity

public void setDesiredCapacity(Integer desiredCapacity)

The desired capacity for the Auto Scaling group.

Parameters:

desiredCapacity - The desired capacity for the Auto Scaling group.

withDesiredCapacity

public UpdateAutoScalingGroupRequest withDesiredCapacity(Integer desiredCapacity)

The desired capacity for the Auto Scaling group.

Returns a reference to this object so that method calls can be chained together.

Parameters:

desiredCapacity - The desired capacity for the Auto Scaling group.

Returns:

A reference to this updated object so that method calls can be chained together.

getDefaultCooldown

public Integer getDefaultCooldown()

The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.

Returns:

The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.

setDefaultCooldown

public void setDefaultCooldown(Integer defaultCooldown)

The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.

Parameters:

defaultCooldown - The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.

withDefaultCooldown

public UpdateAutoScalingGroupRequest withDefaultCooldown(Integer defaultCooldown)

The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.

Returns a reference to this object so that method calls can be chained together.

Parameters:

defaultCooldown - The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.

Returns:

A reference to this updated object so that method calls can be chained together.

getAvailabilityZones

public List<String> getAvailabilityZones()

Availability Zones for the group.

Constraints:
Length: 1 -

Returns:

Availability Zones for the group.

setAvailabilityZones

public void setAvailabilityZones(Collection<String> availabilityZones)

Availability Zones for the group.

Constraints:
Length: 1 -

Parameters:

availabilityZones - Availability Zones for the group.

withAvailabilityZones

public UpdateAutoScalingGroupRequest withAvailabilityZones(String... availabilityZones)

Availability Zones for the group.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -

Parameters:

availabilityZones - Availability Zones for the group.

Returns:

A reference to this updated object so that method calls can be chained together.

withAvailabilityZones

public UpdateAutoScalingGroupRequest withAvailabilityZones(Collection<String> availabilityZones)

Availability Zones for the group.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -

Parameters:

availabilityZones - Availability Zones for the group.

Returns:

A reference to this updated object so that method calls can be chained together.

getHealthCheckType

public String getHealthCheckType()

The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.

Constraints:
Length: 1 - 32
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.

setHealthCheckType

public void setHealthCheckType(String healthCheckType)

The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.

Constraints:
Length: 1 - 32
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

healthCheckType - The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.

withHealthCheckType

public UpdateAutoScalingGroupRequest withHealthCheckType(String healthCheckType)

The service of interest for the health status check, either "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]*

Parameters:

healthCheckType - The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.

Returns:

A reference to this updated object so that method calls can be chained together.

getHealthCheckGracePeriod

public Integer getHealthCheckGracePeriod()

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.

Returns:

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.

setHealthCheckGracePeriod

public void setHealthCheckGracePeriod(Integer 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.

Parameters:

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.

withHealthCheckGracePeriod

public UpdateAutoScalingGroupRequest withHealthCheckGracePeriod(Integer 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getPlacementGroup

public String getPlacementGroup()

The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2 User Guide.

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2 User Guide.

setPlacementGroup

public void setPlacementGroup(String placementGroup)

The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2 User Guide.

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

placementGroup - The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2 User Guide.

withPlacementGroup

public UpdateAutoScalingGroupRequest withPlacementGroup(String placementGroup)

The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2 User Guide.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

placementGroup - The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2 User Guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getVPCZoneIdentifier

public String getVPCZoneIdentifier()

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.

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

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.

setVPCZoneIdentifier

public void setVPCZoneIdentifier(String 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.

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

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.

withVPCZoneIdentifier

public UpdateAutoScalingGroupRequest withVPCZoneIdentifier(String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getTerminationPolicies

public List<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 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 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.

setTerminationPolicies

public void setTerminationPolicies(Collection<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 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.

Parameters:

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.

withTerminationPolicies

public UpdateAutoScalingGroupRequest withTerminationPolicies(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 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.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

withTerminationPolicies

public UpdateAutoScalingGroupRequest withTerminationPolicies(Collection<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 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.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object