Skip to content
v2.273.0

StepScalingActionProps Struct ​

Properties for a scaling policy.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';
import { aws_autoscaling as interfaces_autoscaling } from 'aws-cdk-lib/interfaces';

declare const autoScalingGroupRef: interfaces_autoscaling.IAutoScalingGroupRef;
const stepScalingActionProps: autoscaling.StepScalingActionProps = {
  autoScalingGroup: autoScalingGroupRef,

  // the properties below are optional
  adjustmentType: autoscaling.AdjustmentType.CHANGE_IN_CAPACITY,
  cooldown: cdk.Duration.minutes(30),
  estimatedInstanceWarmup: cdk.Duration.minutes(30),
  metricAggregationType: autoscaling.MetricAggregationType.AVERAGE,
  minAdjustmentMagnitude: 123,
};

Properties ​

adjustmentTypeAdjustmentTypeadjustment_typeAdjustmentTypeadjustmentTypeAdjustmentTypeAdjustmentTypeAdjustmentTypeAdjustmentTypeAdjustmentType= ChangeInCapacity#
How the adjustment numbers are interpreted.
autoScalingGroupIAutoScalingGroupRefauto_scaling_groupIAutoScalingGroupRefautoScalingGroupIAutoScalingGroupRefAutoScalingGroupIAutoScalingGroupRefAutoScalingGroupIAutoScalingGroupRefrequired#
The auto scaling group.
cooldownDurationcooldownDurationcooldownDurationCooldownDurationCooldownDuration= The default cooldown configured …deprecated#
cooldown is not valid with step scaling action
default

Default: The default cooldown configured on the AutoScalingGroup

estimatedInstanceWarmupDurationestimated_instance_warmupDurationestimatedInstanceWarmupDurationEstimatedInstanceWarmupDurationEstimatedInstanceWarmupDuration= Same as the cooldown#
Estimated time until a newly launched instance can send metrics to CloudWatch.
metricAggregationTypeMetricAggregationTypemetric_aggregation_typeMetricAggregationTypemetricAggregationTypeMetricAggregationTypeMetricAggregationTypeMetricAggregationTypeMetricAggregationTypeMetricAggregationType= Average#
The aggregation type for the CloudWatch metrics.
minAdjustmentMagnitudenumbermin_adjustment_magnitudeint | floatminAdjustmentMagnitudeNumberMinAdjustmentMagnitudedoubleMinAdjustmentMagnitude*float64= 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.

Used as props by ​