com.amazonaws.services.autoscaling.model
Class UpdateAutoScalingGroupRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by 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 the new values are specified for the MinSize or MaxSize parameters, then there will be an implicit call to SetDesiredCapacity to set the group to the new MaxSize. All optional parameters are left unchanged if not passed in the request.

See Also:
AmazonAutoScaling.updateAutoScalingGroup(UpdateAutoScalingGroupRequest)

Constructor Summary
UpdateAutoScalingGroupRequest()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getAutoScalingGroupName()
          The name of the Auto Scaling group.
 java.util.List<java.lang.String> getAvailabilityZones()
          Availability Zones for the group.
 java.lang.Integer getDefaultCooldown()
          The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
 java.lang.Integer getDesiredCapacity()
          The desired capacity for the Auto Scaling group.
 java.lang.Integer getHealthCheckGracePeriod()
          The length of time that Auto Scaling waits before checking an instance's health status.
 java.lang.String getHealthCheckType()
          The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.
 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.String getPlacementGroup()
          The name of the cluster placement group, if applicable.
 java.lang.String getVPCZoneIdentifier()
          The subnet identifier for the Amazon VPC connection, if applicable.
 int hashCode()
           
 void setAutoScalingGroupName(java.lang.String autoScalingGroupName)
          The name of the Auto Scaling group.
 void setAvailabilityZones(java.util.Collection<java.lang.String> availabilityZones)
          Availability Zones for the group.
 void setDefaultCooldown(java.lang.Integer defaultCooldown)
          The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
 void setDesiredCapacity(java.lang.Integer desiredCapacity)
          The desired capacity for the Auto Scaling group.
 void setHealthCheckGracePeriod(java.lang.Integer healthCheckGracePeriod)
          The length of time that Auto Scaling waits before checking an instance's health status.
 void setHealthCheckType(java.lang.String healthCheckType)
          The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.
 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 setPlacementGroup(java.lang.String placementGroup)
          The name of the cluster placement group, if applicable.
 void setVPCZoneIdentifier(java.lang.String vPCZoneIdentifier)
          The subnet identifier for the Amazon VPC connection, if applicable.
 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)
          Availability Zones for the group.
 UpdateAutoScalingGroupRequest withAvailabilityZones(java.lang.String... availabilityZones)
          Availability Zones for the group.
 UpdateAutoScalingGroupRequest withDefaultCooldown(java.lang.Integer defaultCooldown)
          The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
 UpdateAutoScalingGroupRequest withDesiredCapacity(java.lang.Integer desiredCapacity)
          The desired capacity for the Auto Scaling group.
 UpdateAutoScalingGroupRequest withHealthCheckGracePeriod(java.lang.Integer healthCheckGracePeriod)
          The length of time that Auto Scaling waits before checking an instance's health status.
 UpdateAutoScalingGroupRequest withHealthCheckType(java.lang.String healthCheckType)
          The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.
 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 withPlacementGroup(java.lang.String placementGroup)
          The name of the cluster placement group, if applicable.
 UpdateAutoScalingGroupRequest withVPCZoneIdentifier(java.lang.String vPCZoneIdentifier)
          The subnet identifier for the Amazon VPC connection, if applicable.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UpdateAutoScalingGroupRequest

public UpdateAutoScalingGroupRequest()
Method Detail

getAutoScalingGroupName

public java.lang.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(java.lang.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(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]*

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 java.lang.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(java.lang.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(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]*

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 java.lang.Integer getMinSize()
The minimum size of the Auto Scaling group.

Returns:
The minimum size of the Auto Scaling group.

setMinSize

public void setMinSize(java.lang.Integer minSize)
The minimum size of the Auto Scaling group.

Parameters:
minSize - The minimum size of the Auto Scaling group.

withMinSize

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.

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 java.lang.Integer getMaxSize()
The maximum size of the Auto Scaling group.

Returns:
The maximum size of the Auto Scaling group.

setMaxSize

public void setMaxSize(java.lang.Integer maxSize)
The maximum size of the Auto Scaling group.

Parameters:
maxSize - The maximum size of the Auto Scaling group.

withMaxSize

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.

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 java.lang.Integer getDesiredCapacity()
The desired capacity for the Auto Scaling group.

Returns:
The desired capacity for the Auto Scaling group.

setDesiredCapacity

public void setDesiredCapacity(java.lang.Integer desiredCapacity)
The desired capacity for the Auto Scaling group.

Parameters:
desiredCapacity - The desired capacity for the Auto Scaling group.

withDesiredCapacity

public UpdateAutoScalingGroupRequest withDesiredCapacity(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.util.List<java.lang.String> getAvailabilityZones()
Availability Zones for the group.

Constraints:
Length: 1 -

Returns:
Availability Zones for the group.

setAvailabilityZones

public void setAvailabilityZones(java.util.Collection<java.lang.String> availabilityZones)
Availability Zones for the group.

Constraints:
Length: 1 -

Parameters:
availabilityZones - Availability Zones for the group.

withAvailabilityZones

public UpdateAutoScalingGroupRequest withAvailabilityZones(java.lang.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(java.util.Collection<java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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.

toString

public java.lang.String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.