AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::AutoScaling::ScalingPolicy

CfnScalingPolicy

The `AWS::AutoScaling::ScalingPolicy` resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application. For more information about using scaling policies to scale your Auto Scaling group automatically, see [Dynamic scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html) and [Predictive scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html) in the *Amazon EC2 Auto Scaling User Guide* .

Import

import { CfnScalingPolicy } from 'aws-cdk-lib/aws-autoscaling';

Or use the module namespace:

import * as autoscaling from 'aws-cdk-lib/aws-autoscaling';
// autoscaling.CfnScalingPolicy

Properties

Configuration passed to the constructor as CfnScalingPolicyProps.

autoScalingGroupNameRequired
string | IAutoScalingGroupRef

The name of the Auto Scaling group.

adjustmentTypeOptional
string

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are `ChangeInCapacity` , `ExactCapacity` , and `PercentChangeInCapacity` . Required if the policy type is `StepScaling` or `SimpleScaling` . For more information, see [Scaling adjustment types](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) in the *Amazon EC2 Auto Scaling User Guide* .

cooldownOptional
string

A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown. Valid only if the policy type is `SimpleScaling` . For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html) in the *Amazon EC2 Auto Scaling User Guide* . Default: None

estimatedInstanceWarmupOptional
number

*Not needed if the default instance warmup is defined for the group.*. The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup. Valid only if the policy type is `TargetTrackingScaling` or `StepScaling` . > The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then `EstimatedInstanceWarmup` falls back to the value of default cooldown.

metricAggregationTypeOptional
string

The aggregation type for the CloudWatch metrics. The valid values are `Minimum` , `Maximum` , and `Average` . If the aggregation type is null, the value is treated as `Average` . Valid only if the policy type is `StepScaling` .

minAdjustmentMagnitudeOptional
number

The minimum value to scale by when the adjustment type is `PercentChangeInCapacity` . For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances. Valid only if the policy type is `StepScaling` or `SimpleScaling` . For more information, see [Scaling adjustment types](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) in the *Amazon EC2 Auto Scaling User Guide* . > Some Auto Scaling groups use instance weights. In this case, set the `MinAdjustmentMagnitude` to a value that is at least as large as your largest instance weight.

policyTypeOptional
string

One of the following policy types:. - `TargetTrackingScaling` - `StepScaling` - `SimpleScaling` (default) - `PredictiveScaling`

predictiveScalingConfigurationOptional
IResolvable | PredictiveScalingConfigurationProperty

A predictive scaling policy. Provides support for predefined and custom metrics. Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count. Required if the policy type is `PredictiveScaling` .

scalingAdjustmentOptional
number

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value. Required if the policy type is `SimpleScaling` . (Not used with any other policy type.)

stepAdjustmentsOptional
IResolvable | IResolvable | StepAdjustmentProperty[]

A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is `StepScaling` . (Not used with any other policy type.)

targetTrackingConfigurationOptional
IResolvable | TargetTrackingConfigurationProperty

A target tracking scaling policy. Provides support for predefined or custom metrics. The following predefined metrics are available: - `ASGAverageCPUUtilization` - `ASGAverageNetworkIn` - `ASGAverageNetworkOut` - `ALBRequestCountPerTarget` If you specify `ALBRequestCountPerTarget` for the metric, you must specify the `ResourceLabel` property with the `PredefinedMetricSpecification` . Required if the policy type is `TargetTrackingScaling` .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter