aws-cdk-lib.aws_applicationautoscaling.BasicStepScalingPolicyProps

interface BasicStepScalingPolicyProps

LanguageType name
.NETAmazon.CDK.AWS.ApplicationAutoScaling.BasicStepScalingPolicyProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapplicationautoscaling#BasicStepScalingPolicyProps
Javasoftware.amazon.awscdk.services.applicationautoscaling.BasicStepScalingPolicyProps
Pythonaws_cdk.aws_applicationautoscaling.BasicStepScalingPolicyProps
TypeScript (source)aws-cdk-lib » aws_applicationautoscaling » BasicStepScalingPolicyProps

Example

declare const capacity: ScalableAttribute;
declare const cpuUtilization: cloudwatch.Metric;

capacity.scaleOnMetric('ScaleToCPU', {
  metric: cpuUtilization,
  scalingSteps: [
    { upper: 10, change: -1 },
    { lower: 50, change: +1 },
    { lower: 70, change: +3 },
  ],

  // Change this to AdjustmentType.PercentChangeInCapacity to interpret the
  // 'change' numbers before as percentages instead of capacity counts.
  adjustmentType: appscaling.AdjustmentType.CHANGE_IN_CAPACITY,
});

Properties

NameTypeDescription
metricIMetricMetric to scale on.
scalingStepsScalingInterval[]The intervals for scaling.
adjustmentType?AdjustmentTypeHow the adjustment numbers inside 'intervals' are interpreted.
cooldown?DurationGrace period after scaling activity.
datapointsToAlarm?numberThe number of data points out of the evaluation periods that must be breaching to trigger a scaling action.
evaluationPeriods?numberHow many evaluation periods of the metric to wait before triggering a scaling action.
metricAggregationType?MetricAggregationTypeAggregation to apply to all data points over the evaluation periods.
minAdjustmentMagnitude?numberMinimum absolute number to adjust capacity with as result of percentage scaling.

metric

Type: IMetric

Metric to scale on.


scalingSteps

Type: ScalingInterval[]

The intervals for scaling.

Maps a range of metric values to a particular scaling behavior.


adjustmentType?

Type: AdjustmentType (optional, default: ChangeInCapacity)

How the adjustment numbers inside 'intervals' are interpreted.


cooldown?

Type: Duration (optional, default: No cooldown period)

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.

See also: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html


datapointsToAlarm?

Type: number (optional, default: evaluationPeriods)

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.


evaluationPeriods?

Type: number (optional, default: 1)

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.


metricAggregationType?

Type: MetricAggregationType (optional, default: The statistic from the metric if applicable (MIN, MAX, AVERAGE), otherwise AVERAGE.)

Aggregation to apply to all data points over the evaluation periods.

Only has meaning if evaluationPeriods != 1.


minAdjustmentMagnitude?

Type: number (optional, default: No minimum scaling effect)

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.