Class StepScalingPolicyConfiguration
- All Implemented Interfaces:
Serializable
,Cloneable
An object representing a step scaling policy configuration.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The adjustment type, which specifies how theScalingAdjustment
parameter in a StepAdjustment is interpreted.The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.The aggregation type for the CloudWatch metrics.The minimum number to adjust your scalable dimension as a result of a scaling activity.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 theScalingAdjustment
parameter in a StepAdjustment is interpreted.void
setAdjustmentType
(String adjustmentType) The adjustment type, which specifies how theScalingAdjustment
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.toString()
Returns a string representation of this object; useful for testing and debugging.withAdjustmentType
(AdjustmentType adjustmentType) The adjustment type, which specifies how theScalingAdjustment
parameter in a StepAdjustment is interpreted.withAdjustmentType
(String adjustmentType) The adjustment type, which specifies how theScalingAdjustment
parameter in a StepAdjustment is interpreted.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.withMetricAggregationType
(MetricAggregationType metricAggregationType) The aggregation type for the CloudWatch metrics.withMetricAggregationType
(String metricAggregationType) The aggregation type for the CloudWatch metrics.withMinAdjustmentMagnitude
(Integer minAdjustmentMagnitude) The minimum number to adjust your scalable dimension as a result of a scaling activity.withStepAdjustments
(StepAdjustment... stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.withStepAdjustments
(Collection<StepAdjustment> stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.
-
Constructor Details
-
StepScalingPolicyConfiguration
public StepScalingPolicyConfiguration()
-
-
Method Details
-
setAdjustmentType
The adjustment type, which specifies how the
ScalingAdjustment
parameter in a StepAdjustment is interpreted.- Parameters:
adjustmentType
- The adjustment type, which specifies how theScalingAdjustment
parameter in a StepAdjustment is interpreted.- See Also:
-
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:
-
withAdjustmentType
The adjustment type, which specifies how the
ScalingAdjustment
parameter in a StepAdjustment is interpreted.- Parameters:
adjustmentType
- The adjustment type, which specifies how theScalingAdjustment
parameter in a StepAdjustment is interpreted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setAdjustmentType
The adjustment type, which specifies how the
ScalingAdjustment
parameter in a StepAdjustment is interpreted.- Parameters:
adjustmentType
- The adjustment type, which specifies how theScalingAdjustment
parameter in a StepAdjustment is interpreted.- See Also:
-
withAdjustmentType
The adjustment type, which specifies how the
ScalingAdjustment
parameter in a StepAdjustment is interpreted.- Parameters:
adjustmentType
- The adjustment type, which specifies how theScalingAdjustment
parameter in a StepAdjustment is interpreted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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)
orwithStepAdjustments(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
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 isPercentChangeInCapacity
, the scaling policy changes the scalable dimension of the scalable target by this amount.
-
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
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 isPercentChangeInCapacity
, 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
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 theCooldown
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 aCooldown
period of 5 minutes starts. During theCooldown
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 theCooldown
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 theCooldown
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 aCooldown
period of 5 minutes starts. During theCooldown
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 theCooldown
period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
-
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 theCooldown
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 aCooldown
period of 5 minutes starts. During theCooldown
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 theCooldown
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 theCooldown
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 aCooldown
period of 5 minutes starts. During theCooldown
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 theCooldown
period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
-
withCooldown
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 theCooldown
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 aCooldown
period of 5 minutes starts. During theCooldown
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 theCooldown
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 theCooldown
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 aCooldown
period of 5 minutes starts. During theCooldown
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 theCooldown
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
The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
.- Parameters:
metricAggregationType
- The aggregation type for the CloudWatch metrics. Valid values areMinimum
,Maximum
, andAverage
.- See Also:
-
getMetricAggregationType
The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
.- Returns:
- The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
. - See Also:
-
withMetricAggregationType
The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
.- Parameters:
metricAggregationType
- The aggregation type for the CloudWatch metrics. Valid values areMinimum
,Maximum
, andAverage
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setMetricAggregationType
The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
.- Parameters:
metricAggregationType
- The aggregation type for the CloudWatch metrics. Valid values areMinimum
,Maximum
, andAverage
.- See Also:
-
withMetricAggregationType
public StepScalingPolicyConfiguration withMetricAggregationType(MetricAggregationType metricAggregationType) The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
.- Parameters:
metricAggregationType
- The aggregation type for the CloudWatch metrics. Valid values areMinimum
,Maximum
, andAverage
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-