aws-cdk-lib.aws_applicationautoscaling.StepScalingActionProps

interface StepScalingActionProps

LanguageType name
.NETAmazon.CDK.AWS.ApplicationAutoScaling.StepScalingActionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapplicationautoscaling#StepScalingActionProps
Javasoftware.amazon.awscdk.services.applicationautoscaling.StepScalingActionProps
Pythonaws_cdk.aws_applicationautoscaling.StepScalingActionProps
TypeScript (source)aws-cdk-lib » aws_applicationautoscaling » 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_applicationautoscaling as appscaling } from 'aws-cdk-lib';

declare const scalableTarget: appscaling.ScalableTarget;
const stepScalingActionProps: appscaling.StepScalingActionProps = {
  scalingTarget: scalableTarget,

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

Properties

NameTypeDescription
scalingTargetIScalableTargetThe scalable target.
adjustmentType?AdjustmentTypeHow the adjustment numbers are interpreted.
cooldown?DurationGrace period after scaling activity.
metricAggregationType?MetricAggregationTypeThe aggregation type for the CloudWatch metrics.
minAdjustmentMagnitude?numberMinimum absolute number to adjust capacity with as result of percentage scaling.
policyName?stringA name for the scaling policy.

scalingTarget

Type: IScalableTarget

The scalable target.


adjustmentType?

Type: AdjustmentType (optional, default: ChangeInCapacity)

How the adjustment numbers are interpreted.


cooldown?

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

Grace period after scaling activity.

For scale out policies, multiple scale outs during the cooldown period are squashed so that only the biggest scale out happens.

For scale in policies, subsequent scale ins during the cooldown period are ignored.

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


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.


policyName?

Type: string (optional, default: Automatically generated name)

A name for the scaling policy.