aws-cdk-lib.aws_autoscaling.StepScalingActionProps

interface StepScalingActionProps

LanguageType name
.NETAmazon.CDK.AWS.AutoScaling.StepScalingActionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsautoscaling#StepScalingActionProps
Javasoftware.amazon.awscdk.services.autoscaling.StepScalingActionProps
Pythonaws_cdk.aws_autoscaling.StepScalingActionProps
TypeScript (source)aws-cdk-lib » aws_autoscaling » StepScalingActionProps

Properties for a scaling policy.

Example

// 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';

declare const autoScalingGroup: autoscaling.AutoScalingGroup;
const stepScalingActionProps: autoscaling.StepScalingActionProps = {
  autoScalingGroup: autoScalingGroup,

  // 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

NameTypeDescription
autoScalingGroupIAutoScalingGroupThe auto scaling group.
adjustmentType?AdjustmentTypeHow the adjustment numbers are interpreted.
cooldown?DurationPeriod after a scaling completes before another scaling activity can start.
estimatedInstanceWarmup?DurationEstimated time until a newly launched instance can send metrics to CloudWatch.
metricAggregationType?MetricAggregationTypeThe aggregation type for the CloudWatch metrics.
minAdjustmentMagnitude?numberMinimum absolute number to adjust capacity with as result of percentage scaling.

autoScalingGroup

Type: IAutoScalingGroup

The auto scaling group.


adjustmentType?

Type: AdjustmentType (optional, default: ChangeInCapacity)

How the adjustment numbers are interpreted.


cooldown?

Type: Duration (optional, default: The default cooldown configured on the AutoScalingGroup)

Period after a scaling completes before another scaling activity can start.


estimatedInstanceWarmup?

Type: Duration (optional, default: Same as the cooldown)

Estimated time until a newly launched instance can send metrics to CloudWatch.


metricAggregationType?

Type: MetricAggregationType (optional, default: Average)

The aggregation type for the CloudWatch metrics.


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.