com.amazonaws.services.autoscaling.model

Class PutScalingPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.PutScalingPolicyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PutScalingPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the PutScalingPolicy operation.

Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.

See Also:

AmazonAutoScaling.putScalingPolicy(PutScalingPolicyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutScalingPolicyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
PutScalingPolicyRequest	clone()
boolean	equals(Object obj)
String	getAdjustmentType() The adjustment type.
String	getAutoScalingGroupName() The name or ARN of the group.
Integer	getCooldown() The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.
Integer	getMinAdjustmentStep() Used with AdjustmentType with the value PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.
String	getPolicyName() The name of the policy.
Integer	getScalingAdjustment() The number of instances by which to scale.
int	hashCode()
void	setAdjustmentType(String adjustmentType) The adjustment type.
void	setAutoScalingGroupName(String autoScalingGroupName) The name or ARN of the group.
void	setCooldown(Integer cooldown) The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.
void	setMinAdjustmentStep(Integer minAdjustmentStep) Used with AdjustmentType with the value PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.
void	setPolicyName(String policyName) The name of the policy.
void	setScalingAdjustment(Integer scalingAdjustment) The number of instances by which to scale.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutScalingPolicyRequest	withAdjustmentType(String adjustmentType) The adjustment type.
PutScalingPolicyRequest	withAutoScalingGroupName(String autoScalingGroupName) The name or ARN of the group.
PutScalingPolicyRequest	withCooldown(Integer cooldown) The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.
PutScalingPolicyRequest	withMinAdjustmentStep(Integer minAdjustmentStep) Used with AdjustmentType with the value PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.
PutScalingPolicyRequest	withPolicyName(String policyName) The name of the policy.
PutScalingPolicyRequest	withScalingAdjustment(Integer scalingAdjustment) The number of instances by which to scale.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutScalingPolicyRequest

public PutScalingPolicyRequest()

Method Detail

getAutoScalingGroupName

public String getAutoScalingGroupName()

The name or ARN of the group.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The name or ARN of the group.

setAutoScalingGroupName

public void setAutoScalingGroupName(String autoScalingGroupName)

The name or ARN of the group.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

autoScalingGroupName - The name or ARN of the group.

withAutoScalingGroupName

public PutScalingPolicyRequest withAutoScalingGroupName(String autoScalingGroupName)

The name or ARN of the group.

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]*

Parameters:

autoScalingGroupName - The name or ARN of the group.

Returns:

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

getPolicyName

public String getPolicyName()

The name of the policy.

Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The name of the policy.

setPolicyName

public void setPolicyName(String policyName)

The name of the policy.

Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

policyName - The name of the policy.

withPolicyName

public PutScalingPolicyRequest withPolicyName(String policyName)

The name of the policy.

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]*

Parameters:

policyName - The name of the policy.

Returns:

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

getScalingAdjustment

public Integer getScalingAdjustment()

The number of instances by which to scale. AdjustmentType determines the interpretation of this number (for example, as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity.

Returns:

The number of instances by which to scale. AdjustmentType determines the interpretation of this number (for example, as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity.

setScalingAdjustment

public void setScalingAdjustment(Integer scalingAdjustment)

The number of instances by which to scale. AdjustmentType determines the interpretation of this number (for example, as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity.

Parameters:

scalingAdjustment - The number of instances by which to scale. AdjustmentType determines the interpretation of this number (for example, as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity.

withScalingAdjustment

public PutScalingPolicyRequest withScalingAdjustment(Integer scalingAdjustment)

The number of instances by which to scale. AdjustmentType determines the interpretation of this number (for example, as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity.

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

Parameters:

scalingAdjustment - The number of instances by which to scale. AdjustmentType determines the interpretation of this number (for example, as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity.

Returns:

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

getAdjustmentType

public String getAdjustmentType()

The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.

Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.

setAdjustmentType

public void setAdjustmentType(String adjustmentType)

The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.

Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

adjustmentType - The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.

withAdjustmentType

public PutScalingPolicyRequest withAdjustmentType(String adjustmentType)

The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

For more information, see Dynamic Scaling 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]*

Parameters:

adjustmentType - The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.

Returns:

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

getCooldown

public Integer getCooldown()

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.

For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.

Returns:

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.

For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.

setCooldown

public void setCooldown(Integer cooldown)

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.

For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.

Parameters:

cooldown - The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.

For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.

withCooldown

public PutScalingPolicyRequest withCooldown(Integer cooldown)

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.

For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.

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

Parameters:

cooldown - The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.

For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.

Returns:

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

getMinAdjustmentStep

public Integer getMinAdjustmentStep()

Used with AdjustmentType with the value PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.

You will get a ValidationError if you use MinAdjustmentStep on a policy with an AdjustmentType other than PercentChangeInCapacity.

Returns:

Used with AdjustmentType with the value PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.

You will get a ValidationError if you use MinAdjustmentStep on a policy with an AdjustmentType other than PercentChangeInCapacity.

setMinAdjustmentStep

public void setMinAdjustmentStep(Integer minAdjustmentStep)

Used with AdjustmentType with the value PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.

You will get a ValidationError if you use MinAdjustmentStep on a policy with an AdjustmentType other than PercentChangeInCapacity.

Parameters:

minAdjustmentStep - Used with AdjustmentType with the value PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.

You will get a ValidationError if you use MinAdjustmentStep on a policy with an AdjustmentType other than PercentChangeInCapacity.

withMinAdjustmentStep

public PutScalingPolicyRequest withMinAdjustmentStep(Integer minAdjustmentStep)

Used with AdjustmentType with the value PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.

You will get a ValidationError if you use MinAdjustmentStep on a policy with an AdjustmentType other than PercentChangeInCapacity.

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

Parameters:

minAdjustmentStep - Used with AdjustmentType with the value PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.

You will get a ValidationError if you use MinAdjustmentStep on a policy with an AdjustmentType other than PercentChangeInCapacity.

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

clone

public PutScalingPolicyRequest clone()

Overrides:

clone in class AmazonWebServiceRequest