BasicStepScalingPolicyProps

All Known Subinterfaces:: StepScalingPolicyProps

All Known Implementing Classes:: BasicStepScalingPolicyProps.Jsii$Proxy, StepScalingPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:57.923Z")
public interface BasicStepScalingPolicyProps

Example:

 ScalableAttribute capacity;
 Metric cpuUtilization;
 capacity.scaleOnMetric("ScaleToCPU", BasicStepScalingPolicyProps.builder()
         .metric(cpuUtilization)
         .scalingSteps(List.of(ScalingInterval.builder().upper(10).change(-1).build(), ScalingInterval.builder().lower(50).change(+1).build(), ScalingInterval.builder().lower(70).change(+3).build()))
         // Change this to AdjustmentType.PercentChangeInCapacity to interpret the
         // 'change' numbers before as percentages instead of capacity counts.
         .adjustmentType(AdjustmentType.CHANGE_IN_CAPACITY)
         .build());

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`BasicStepScalingPolicyProps.Builder` A builder for `BasicStepScalingPolicyProps`
`static class`	`BasicStepScalingPolicyProps.Jsii$Proxy` An implementation for `BasicStepScalingPolicyProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static BasicStepScalingPolicyProps.Builder`	`builder()`
`default AdjustmentType`	`getAdjustmentType()` How the adjustment numbers inside 'intervals' are interpreted.
`default Duration`	`getCooldown()` Grace period after scaling activity.
`default java.lang.Number`	`getDatapointsToAlarm()` The number of data points out of the evaluation periods that must be breaching to trigger a scaling action.
`default java.lang.Number`	`getEvaluationPeriods()` How many evaluation periods of the metric to wait before triggering a scaling action.
`IMetric`	`getMetric()` Metric to scale on.
`default MetricAggregationType`	`getMetricAggregationType()` Aggregation to apply to all data points over the evaluation periods.
`default java.lang.Number`	`getMinAdjustmentMagnitude()` Minimum absolute number to adjust capacity with as result of percentage scaling.
`java.util.List<ScalingInterval>`	`getScalingSteps()` The intervals for scaling.

- Method Detail
  - getMetric
```
IMetric getMetric()
```
    Metric to scale on.
  - getScalingSteps
```
java.util.List<ScalingInterval> getScalingSteps()
```
    The intervals for scaling.
    Maps a range of metric values to a particular scaling behavior.
  - getAdjustmentType
```
default AdjustmentType getAdjustmentType()
```
    How the adjustment numbers inside 'intervals' are interpreted.
    Default: ChangeInCapacity
  - getCooldown
```
default Duration getCooldown()
```
    Grace period after scaling activity.
    Subsequent scale outs during the cooldown period are squashed so that only the biggest scale out happens.
    Subsequent scale ins during the cooldown period are ignored.
    Default: No cooldown period
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html
  - getDatapointsToAlarm
```
default java.lang.Number getDatapointsToAlarm()
```
    The number of data points out of the evaluation periods that must be breaching to trigger a scaling action.
    Creates an "M out of N" alarm, where this property is the M and the value set for evaluationPeriods is the N value.
    Only has meaning if evaluationPeriods != 1.
    Default: `evaluationPeriods`
  - getEvaluationPeriods
```
default java.lang.Number getEvaluationPeriods()
```
    How many evaluation periods of the metric to wait before triggering a scaling action.
    Raising this value can be used to smooth out the metric, at the expense of slower response times.
    If datapointsToAlarm is not set, then all data points in the evaluation period must meet the criteria to trigger a scaling action.
    Default: 1
  - getMetricAggregationType
```
default MetricAggregationType getMetricAggregationType()
```
    Aggregation to apply to all data points over the evaluation periods.
    Only has meaning if evaluationPeriods != 1.
    Default: - The statistic from the metric if applicable (MIN, MAX, AVERAGE), otherwise AVERAGE.
  - getMinAdjustmentMagnitude
```
default java.lang.Number getMinAdjustmentMagnitude()
```
    Minimum absolute number to adjust capacity with as result of percentage scaling.
    Only when using AdjustmentType = PercentChangeInCapacity, this number controls the minimum absolute effect size.
    Default: No minimum scaling effect
  - builder
```
static BasicStepScalingPolicyProps.Builder builder()
```
    Returns:
    
    a BasicStepScalingPolicyProps.Builder of BasicStepScalingPolicyProps

Interface BasicStepScalingPolicyProps

Nested Class Summary

Method Summary

Method Detail

getMetric

getScalingSteps

getAdjustmentType

getCooldown

getDatapointsToAlarm

getEvaluationPeriods

getMetricAggregationType

getMinAdjustmentMagnitude

builder