com.amazonaws.services.applicationautoscaling.model

Class StepScalingPolicyConfiguration

java.lang.Object

com.amazonaws.services.applicationautoscaling.model.StepScalingPolicyConfiguration

All Implemented Interfaces:

Serializable, Cloneable

public class StepScalingPolicyConfiguration
extends Object
implements Serializable, Cloneable

An object representing a step scaling policy configuration.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StepScalingPolicyConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
StepScalingPolicyConfiguration	clone()
boolean	equals(Object obj)
String	getAdjustmentType() The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.
Integer	getCooldown() The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.
String	getMetricAggregationType() The aggregation type for the CloudWatch metrics.
Integer	getMinAdjustmentMagnitude() The minimum number to adjust your scalable dimension as a result of a scaling activity.
List<StepAdjustment>	getStepAdjustments() A set of adjustments that enable you to scale based on the size of the alarm breach.
int	hashCode()
void	setAdjustmentType(AdjustmentType adjustmentType) The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.
void	setAdjustmentType(String adjustmentType) The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.
void	setCooldown(Integer cooldown) The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.
void	setMetricAggregationType(MetricAggregationType metricAggregationType) The aggregation type for the CloudWatch metrics.
void	setMetricAggregationType(String metricAggregationType) The aggregation type for the CloudWatch metrics.
void	setMinAdjustmentMagnitude(Integer minAdjustmentMagnitude) The minimum number to adjust your scalable dimension as a result of a scaling activity.
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.
StepScalingPolicyConfiguration	withAdjustmentType(AdjustmentType adjustmentType) The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.
StepScalingPolicyConfiguration	withAdjustmentType(String adjustmentType) The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.
StepScalingPolicyConfiguration	withCooldown(Integer cooldown) The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.
StepScalingPolicyConfiguration	withMetricAggregationType(MetricAggregationType metricAggregationType) The aggregation type for the CloudWatch metrics.
StepScalingPolicyConfiguration	withMetricAggregationType(String metricAggregationType) The aggregation type for the CloudWatch metrics.
StepScalingPolicyConfiguration	withMinAdjustmentMagnitude(Integer minAdjustmentMagnitude) The minimum number to adjust your scalable dimension as a result of a scaling activity.
StepScalingPolicyConfiguration	withStepAdjustments(Collection<StepAdjustment> stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.
StepScalingPolicyConfiguration	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

StepScalingPolicyConfiguration

public StepScalingPolicyConfiguration()

Method Detail

setAdjustmentType

public void setAdjustmentType(String adjustmentType)

The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.

Parameters:

adjustmentType - The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.

See Also:

AdjustmentType

getAdjustmentType

public String getAdjustmentType()

The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.

Returns:

The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.

See Also:

AdjustmentType

withAdjustmentType

public StepScalingPolicyConfiguration withAdjustmentType(String adjustmentType)

The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.

Parameters:

adjustmentType - The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.

Returns:

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

See Also:

AdjustmentType

setAdjustmentType

public void setAdjustmentType(AdjustmentType adjustmentType)

The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.

Parameters:

adjustmentType - The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.

See Also:

AdjustmentType

withAdjustmentType

public StepScalingPolicyConfiguration withAdjustmentType(AdjustmentType adjustmentType)

The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.

Parameters:

adjustmentType - The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.

Returns:

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

See Also:

AdjustmentType

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

Parameters:

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

Returns:

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

withStepAdjustments

public StepScalingPolicyConfiguration withStepAdjustments(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.

Returns:

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

setMinAdjustmentMagnitude

public void setMinAdjustmentMagnitude(Integer minAdjustmentMagnitude)

The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

Parameters:

minAdjustmentMagnitude - The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

getMinAdjustmentMagnitude

public Integer getMinAdjustmentMagnitude()

The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

Returns:

The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

withMinAdjustmentMagnitude

public StepScalingPolicyConfiguration withMinAdjustmentMagnitude(Integer minAdjustmentMagnitude)

The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

Parameters:

minAdjustmentMagnitude - The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

Returns:

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

setCooldown

public void setCooldown(Integer cooldown)

The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.

For scale out policies, while Cooldown is in effect, the capacity that has been added by the previous scale out event that initiated the Cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a Cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.

For scale in policies, the Cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the Cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

Parameters:

cooldown - The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.

For scale out policies, while Cooldown is in effect, the capacity that has been added by the previous scale out event that initiated the Cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a Cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.

For scale in policies, the Cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the Cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

getCooldown

public Integer getCooldown()

The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.

For scale out policies, while Cooldown is in effect, the capacity that has been added by the previous scale out event that initiated the Cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a Cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.

For scale in policies, the Cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the Cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

Returns:

The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.

For scale out policies, while Cooldown is in effect, the capacity that has been added by the previous scale out event that initiated the Cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a Cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.

For scale in policies, the Cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the Cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

withCooldown

public StepScalingPolicyConfiguration withCooldown(Integer cooldown)

The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.

For scale out policies, while Cooldown is in effect, the capacity that has been added by the previous scale out event that initiated the Cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a Cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.

For scale in policies, the Cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the Cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

Parameters:

cooldown - The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.

For scale out policies, while Cooldown is in effect, the capacity that has been added by the previous scale out event that initiated the Cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a Cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.

For scale in policies, the Cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the Cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

Returns:

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

setMetricAggregationType

public void setMetricAggregationType(String metricAggregationType)

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

Parameters:

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

See Also:

MetricAggregationType

getMetricAggregationType

public String getMetricAggregationType()

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

Returns:

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

See Also:

MetricAggregationType

withMetricAggregationType

public StepScalingPolicyConfiguration withMetricAggregationType(String metricAggregationType)

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

Parameters:

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

Returns:

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

See Also:

MetricAggregationType

setMetricAggregationType

public void setMetricAggregationType(MetricAggregationType metricAggregationType)

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

Parameters:

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

See Also:

MetricAggregationType

withMetricAggregationType

public StepScalingPolicyConfiguration withMetricAggregationType(MetricAggregationType metricAggregationType)

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

Parameters:

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

Returns:

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

See Also:

MetricAggregationType

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StepScalingPolicyConfiguration clone()

Overrides:

clone in class Object