Interface BasicStepScalingPolicyProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
StepScalingPolicyProps
- All Known Implementing Classes:
BasicStepScalingPolicyProps.Jsii$Proxy
,StepScalingPolicyProps.Jsii$Proxy
AutoScalingGroup autoScalingGroup; Metric workerUtilizationMetric = Metric.Builder.create() .namespace("MyService") .metricName("WorkerUtilization") .build(); autoScalingGroup.scaleOnMetric("ScaleToCPU", BasicStepScalingPolicyProps.builder() .metric(workerUtilizationMetric) .scalingSteps(List.of(ScalingInterval.builder().upper(10).change(-1).build(), ScalingInterval.builder().lower(50).change(+1).build(), ScalingInterval.builder().lower(70).change(+3).build())) .evaluationPeriods(10) .datapointsToAlarm(5) // Change this to AdjustmentType.PERCENT_CHANGE_IN_CAPACITY to interpret the // 'change' numbers before as percentages instead of capacity counts. .adjustmentType(AdjustmentType.CHANGE_IN_CAPACITY) .build());
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forBasicStepScalingPolicyProps
static final class
An implementation forBasicStepScalingPolicyProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default AdjustmentType
How the adjustment numbers inside 'intervals' are interpreted.default Duration
Grace period after scaling activity.default Number
The number of data points out of the evaluation periods that must be breaching to trigger a scaling action.default Duration
Estimated time until a newly launched instance can send metrics to CloudWatch.default Number
How many evaluation periods of the metric to wait before triggering a scaling action.Metric to scale on.default MetricAggregationType
Aggregation to apply to all data points over the evaluation periods.default Number
Minimum absolute number to adjust capacity with as result of percentage scaling.The intervals for scaling.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getMetric
Metric to scale on. -
getScalingSteps
The intervals for scaling.Maps a range of metric values to a particular scaling behavior.
Must be between 2 and 40 steps.
-
getAdjustmentType
How the adjustment numbers inside 'intervals' are interpreted.Default: ChangeInCapacity
-
getCooldown
Grace period after scaling activity.Default: Default cooldown period on your AutoScalingGroup
-
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
. Must be less than or equal toevaluationPeriods
.Default: - Same as `evaluationPeriods`
-
getEstimatedInstanceWarmup
Estimated time until a newly launched instance can send metrics to CloudWatch.Default: Same as the cooldown
-
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
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
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
-