com.amazonaws.services.autoscaling.model

Class ScalingPolicy

java.lang.Object

com.amazonaws.services.autoscaling.model.ScalingPolicy

All Implemented Interfaces:

Serializable, Cloneable

public class ScalingPolicy
extends Object
implements Serializable, Cloneable

Describes a scaling policy.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScalingPolicy()

Method Summary

Methods

Modifier and Type	Method and Description
ScalingPolicy	clone()
boolean	equals(Object obj)
String	getAdjustmentType() The adjustment type, which specifies how ScalingAdjustment is interpreted.
List<Alarm>	getAlarms() The CloudWatch alarms related to the policy.
String	getAutoScalingGroupName() The name of the Auto Scaling group associated with this scaling policy.
Integer	getCooldown() The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
Integer	getEstimatedInstanceWarmup() The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
String	getMetricAggregationType() The aggregation type for the CloudWatch metrics.
Integer	getMinAdjustmentMagnitude() The minimum number of instances to scale.
Integer	getMinAdjustmentStep() Available for backward compatibility.
String	getPolicyARN() The Amazon Resource Name (ARN) of the policy.
String	getPolicyName() The name of the scaling policy.
String	getPolicyType() The policy type.
Integer	getScalingAdjustment() The amount by which to scale, based on the specified adjustment type.
List<StepAdjustment>	getStepAdjustments() A set of adjustments that enable you to scale based on the size of the alarm breach.
int	hashCode()
void	setAdjustmentType(String adjustmentType) The adjustment type, which specifies how ScalingAdjustment is interpreted.
void	setAlarms(Collection<Alarm> alarms) The CloudWatch alarms related to the policy.
void	setAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group associated with this scaling policy.
void	setCooldown(Integer cooldown) The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
void	setEstimatedInstanceWarmup(Integer estimatedInstanceWarmup) The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
void	setMetricAggregationType(String metricAggregationType) The aggregation type for the CloudWatch metrics.
void	setMinAdjustmentMagnitude(Integer minAdjustmentMagnitude) The minimum number of instances to scale.
void	setMinAdjustmentStep(Integer minAdjustmentStep) Available for backward compatibility.
void	setPolicyARN(String policyARN) The Amazon Resource Name (ARN) of the policy.
void	setPolicyName(String policyName) The name of the scaling policy.
void	setPolicyType(String policyType) The policy type.
void	setScalingAdjustment(Integer scalingAdjustment) The amount by which to scale, based on the specified adjustment type.
void	setStepAdjustments(Collection<StepAdjustment> stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ScalingPolicy	withAdjustmentType(String adjustmentType) The adjustment type, which specifies how ScalingAdjustment is interpreted.
ScalingPolicy	withAlarms(Alarm... alarms) The CloudWatch alarms related to the policy.
ScalingPolicy	withAlarms(Collection<Alarm> alarms) The CloudWatch alarms related to the policy.
ScalingPolicy	withAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group associated with this scaling policy.
ScalingPolicy	withCooldown(Integer cooldown) The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
ScalingPolicy	withEstimatedInstanceWarmup(Integer estimatedInstanceWarmup) The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
ScalingPolicy	withMetricAggregationType(String metricAggregationType) The aggregation type for the CloudWatch metrics.
ScalingPolicy	withMinAdjustmentMagnitude(Integer minAdjustmentMagnitude) The minimum number of instances to scale.
ScalingPolicy	withMinAdjustmentStep(Integer minAdjustmentStep) Available for backward compatibility.
ScalingPolicy	withPolicyARN(String policyARN) The Amazon Resource Name (ARN) of the policy.
ScalingPolicy	withPolicyName(String policyName) The name of the scaling policy.
ScalingPolicy	withPolicyType(String policyType) The policy type.
ScalingPolicy	withScalingAdjustment(Integer scalingAdjustment) The amount by which to scale, based on the specified adjustment type.
ScalingPolicy	withStepAdjustments(Collection<StepAdjustment> stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.
ScalingPolicy	withStepAdjustments(StepAdjustment... stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScalingPolicy

public ScalingPolicy()

Method Detail

getAutoScalingGroupName

public String getAutoScalingGroupName()

The name of the Auto Scaling group associated with this scaling policy.

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

Returns:

The name of the Auto Scaling group associated with this scaling policy.

setAutoScalingGroupName

public void setAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group associated with this scaling policy.

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

Parameters:

autoScalingGroupName - The name of the Auto Scaling group associated with this scaling policy.

withAutoScalingGroupName

public ScalingPolicy withAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group associated with this scaling 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:

autoScalingGroupName - The name of the Auto Scaling group associated with this scaling policy.

Returns:

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

getPolicyName

public String getPolicyName()

The name of the scaling policy.

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

Returns:

The name of the scaling policy.

setPolicyName

public void setPolicyName(String policyName)

The name of the scaling policy.

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

Parameters:

policyName - The name of the scaling policy.

withPolicyName

public ScalingPolicy withPolicyName(String policyName)

The name of the scaling 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 scaling policy.

Returns:

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

getPolicyARN

public String getPolicyARN()

The Amazon Resource Name (ARN) of the policy.

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

Returns:

The Amazon Resource Name (ARN) of the policy.

setPolicyARN

public void setPolicyARN(String policyARN)

The Amazon Resource Name (ARN) of the policy.

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

Parameters:

policyARN - The Amazon Resource Name (ARN) of the policy.

withPolicyARN

public ScalingPolicy withPolicyARN(String policyARN)

The Amazon Resource Name (ARN) of the policy.

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:

policyARN - The Amazon Resource Name (ARN) of the policy.

Returns:

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

getPolicyType

public String getPolicyType()

The policy type. Valid values are SimpleScaling and StepScaling.

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

Returns:

The policy type. Valid values are SimpleScaling and StepScaling.

setPolicyType

public void setPolicyType(String policyType)

The policy type. Valid values are SimpleScaling and StepScaling.

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

Parameters:

policyType - The policy type. Valid values are SimpleScaling and StepScaling.

withPolicyType

public ScalingPolicy withPolicyType(String policyType)

The policy type. Valid values are SimpleScaling and StepScaling.

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

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

Parameters:

policyType - The policy type. Valid values are SimpleScaling and StepScaling.

Returns:

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

getAdjustmentType

public String getAdjustmentType()

The adjustment type, which specifies how ScalingAdjustment is interpreted. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

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

Returns:

The adjustment type, which specifies how ScalingAdjustment is interpreted. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

setAdjustmentType

public void setAdjustmentType(String adjustmentType)

The adjustment type, which specifies how ScalingAdjustment is interpreted. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

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

Parameters:

adjustmentType - The adjustment type, which specifies how ScalingAdjustment is interpreted. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

withAdjustmentType

public ScalingPolicy withAdjustmentType(String adjustmentType)

The adjustment type, which specifies how ScalingAdjustment is interpreted. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

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, which specifies how ScalingAdjustment is interpreted. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Returns:

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

getMinAdjustmentStep

public Integer getMinAdjustmentStep()

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Returns:

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

setMinAdjustmentStep

public void setMinAdjustmentStep(Integer minAdjustmentStep)

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Parameters:

minAdjustmentStep - Available for backward compatibility. Use MinAdjustmentMagnitude instead.

withMinAdjustmentStep

public ScalingPolicy withMinAdjustmentStep(Integer minAdjustmentStep)

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

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

Parameters:

minAdjustmentStep - Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Returns:

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

getMinAdjustmentMagnitude

public Integer getMinAdjustmentMagnitude()

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

Returns:

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

setMinAdjustmentMagnitude

public void setMinAdjustmentMagnitude(Integer minAdjustmentMagnitude)

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

Parameters:

minAdjustmentMagnitude - The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

withMinAdjustmentMagnitude

public ScalingPolicy withMinAdjustmentMagnitude(Integer minAdjustmentMagnitude)

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

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

Parameters:

minAdjustmentMagnitude - The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

Returns:

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

getScalingAdjustment

public Integer getScalingAdjustment()

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

Returns:

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

setScalingAdjustment

public void setScalingAdjustment(Integer scalingAdjustment)

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

Parameters:

scalingAdjustment - The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

withScalingAdjustment

public ScalingPolicy withScalingAdjustment(Integer scalingAdjustment)

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

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

Parameters:

scalingAdjustment - The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

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

setCooldown

public void setCooldown(Integer cooldown)

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

Parameters:

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

withCooldown

public ScalingPolicy withCooldown(Integer cooldown)

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:

cooldown - 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.

getStepAdjustments

public List<StepAdjustment> getStepAdjustments()

A set of adjustments that enable you to scale based on the size of the alarm breach.

Returns:

A set of adjustments that enable you to scale based on the size of the alarm breach.

setStepAdjustments

public void setStepAdjustments(Collection<StepAdjustment> stepAdjustments)

A set of adjustments that enable you to scale based on the size of the alarm breach.

Parameters:

stepAdjustments - A set of adjustments that enable you to scale based on the size of the alarm breach.

withStepAdjustments

public ScalingPolicy withStepAdjustments(StepAdjustment... stepAdjustments)

A set of adjustments that enable you to scale based on the size of the alarm breach.

NOTE: This method appends the values to the existing list (if any). Use setStepAdjustments(java.util.Collection) or withStepAdjustments(java.util.Collection) if you want to override the existing values.

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

Parameters:

stepAdjustments - A set of adjustments that enable you to scale based on the size of the alarm breach.

Returns:

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

withStepAdjustments

public ScalingPolicy withStepAdjustments(Collection<StepAdjustment> stepAdjustments)

A set of adjustments that enable you to scale based on the size of the alarm breach.

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

Parameters:

stepAdjustments - A set of adjustments that enable you to scale based on the size of the alarm breach.

Returns:

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

getMetricAggregationType

public String getMetricAggregationType()

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

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

Returns:

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

setMetricAggregationType

public void setMetricAggregationType(String metricAggregationType)

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

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

Parameters:

metricAggregationType - The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

withMetricAggregationType

public ScalingPolicy withMetricAggregationType(String metricAggregationType)

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

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

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

Parameters:

metricAggregationType - The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

Returns:

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

getEstimatedInstanceWarmup

public Integer getEstimatedInstanceWarmup()

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

Returns:

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

setEstimatedInstanceWarmup

public void setEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

Parameters:

estimatedInstanceWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

withEstimatedInstanceWarmup

public ScalingPolicy withEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

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

Parameters:

estimatedInstanceWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

Returns:

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

getAlarms

public List<Alarm> getAlarms()

The CloudWatch alarms related to the policy.

Returns:

The CloudWatch alarms related to the policy.

setAlarms

public void setAlarms(Collection<Alarm> alarms)

The CloudWatch alarms related to the policy.

Parameters:

alarms - The CloudWatch alarms related to the policy.

withAlarms

public ScalingPolicy withAlarms(Alarm... alarms)

The CloudWatch alarms related to the policy.

NOTE: This method appends the values to the existing list (if any). Use setAlarms(java.util.Collection) or withAlarms(java.util.Collection) if you want to override the existing values.

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

Parameters:

alarms - The CloudWatch alarms related to the policy.

Returns:

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

withAlarms

public ScalingPolicy withAlarms(Collection<Alarm> alarms)

The CloudWatch alarms related to the policy.

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

Parameters:

alarms - The CloudWatch alarms related to the policy.

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 ScalingPolicy clone()

Overrides:

clone in class Object