interface CfnScalingPolicyProps

Language	Type name
.NET	`Amazon.CDK.AWS.AutoScaling.CfnScalingPolicyProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsautoscaling#CfnScalingPolicyProps`
Java	`software.amazon.awscdk.services.autoscaling.CfnScalingPolicyProps`
Python	`aws_cdk.aws_autoscaling.CfnScalingPolicyProps`
TypeScript	`aws-cdk-lib` » `aws_autoscaling` » `CfnScalingPolicyProps`

Properties for defining a CfnScalingPolicy.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';
const cfnScalingPolicyProps: autoscaling.CfnScalingPolicyProps = {
  autoScalingGroupName: 'autoScalingGroupName',

  // the properties below are optional
  adjustmentType: 'adjustmentType',
  cooldown: 'cooldown',
  estimatedInstanceWarmup: 123,
  metricAggregationType: 'metricAggregationType',
  minAdjustmentMagnitude: 123,
  policyType: 'policyType',
  predictiveScalingConfiguration: {
    metricSpecifications: [{
      targetValue: 123,

      // the properties below are optional
      customizedCapacityMetricSpecification: {
        metricDataQueries: [{
          id: 'id',

          // the properties below are optional
          expression: 'expression',
          label: 'label',
          metricStat: {
            metric: {
              metricName: 'metricName',
              namespace: 'namespace',

              // the properties below are optional
              dimensions: [{
                name: 'name',
                value: 'value',
              }],
            },
            stat: 'stat',

            // the properties below are optional
            unit: 'unit',
          },
          returnData: false,
        }],
      },
      customizedLoadMetricSpecification: {
        metricDataQueries: [{
          id: 'id',

          // the properties below are optional
          expression: 'expression',
          label: 'label',
          metricStat: {
            metric: {
              metricName: 'metricName',
              namespace: 'namespace',

              // the properties below are optional
              dimensions: [{
                name: 'name',
                value: 'value',
              }],
            },
            stat: 'stat',

            // the properties below are optional
            unit: 'unit',
          },
          returnData: false,
        }],
      },
      customizedScalingMetricSpecification: {
        metricDataQueries: [{
          id: 'id',

          // the properties below are optional
          expression: 'expression',
          label: 'label',
          metricStat: {
            metric: {
              metricName: 'metricName',
              namespace: 'namespace',

              // the properties below are optional
              dimensions: [{
                name: 'name',
                value: 'value',
              }],
            },
            stat: 'stat',

            // the properties below are optional
            unit: 'unit',
          },
          returnData: false,
        }],
      },
      predefinedLoadMetricSpecification: {
        predefinedMetricType: 'predefinedMetricType',

        // the properties below are optional
        resourceLabel: 'resourceLabel',
      },
      predefinedMetricPairSpecification: {
        predefinedMetricType: 'predefinedMetricType',

        // the properties below are optional
        resourceLabel: 'resourceLabel',
      },
      predefinedScalingMetricSpecification: {
        predefinedMetricType: 'predefinedMetricType',

        // the properties below are optional
        resourceLabel: 'resourceLabel',
      },
    }],

    // the properties below are optional
    maxCapacityBreachBehavior: 'maxCapacityBreachBehavior',
    maxCapacityBuffer: 123,
    mode: 'mode',
    schedulingBufferTime: 123,
  },
  scalingAdjustment: 123,
  stepAdjustments: [{
    scalingAdjustment: 123,

    // the properties below are optional
    metricIntervalLowerBound: 123,
    metricIntervalUpperBound: 123,
  }],
  targetTrackingConfiguration: {
    targetValue: 123,

    // the properties below are optional
    customizedMetricSpecification: {
      dimensions: [{
        name: 'name',
        value: 'value',
      }],
      metricName: 'metricName',
      metrics: [{
        id: 'id',

        // the properties below are optional
        expression: 'expression',
        label: 'label',
        metricStat: {
          metric: {
            metricName: 'metricName',
            namespace: 'namespace',

            // the properties below are optional
            dimensions: [{
              name: 'name',
              value: 'value',
            }],
          },
          stat: 'stat',

          // the properties below are optional
          period: 123,
          unit: 'unit',
        },
        period: 123,
        returnData: false,
      }],
      namespace: 'namespace',
      period: 123,
      statistic: 'statistic',
      unit: 'unit',
    },
    disableScaleIn: false,
    predefinedMetricSpecification: {
      predefinedMetricType: 'predefinedMetricType',

      // the properties below are optional
      resourceLabel: 'resourceLabel',
    },
  },
};

Properties

Name	Type	Description
autoScalingGroupName	`string`	The name of the Auto Scaling group.
adjustmentType?	`string`	Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).
cooldown?	`string`	A cooldown period, in seconds, that applies to a specific simple scaling policy.
estimatedInstanceWarmup?	`number`	Not needed if the default instance warmup is defined for the group..
metricAggregationType?	`string`	The aggregation type for the CloudWatch metrics.
minAdjustmentMagnitude?	`number`	The minimum value to scale by when the adjustment type is `PercentChangeInCapacity` .
policyType?	`string`	One of the following policy types:.
predictiveScalingConfiguration?	`IResolvable` `\|` `PredictiveScalingConfigurationProperty`	A predictive scaling policy. Provides support for predefined and custom metrics.
scalingAdjustment?	`number`	The amount by which to scale, based on the specified adjustment type.
stepAdjustments?	`IResolvable` `\|` `IResolvable` `\|` `StepAdjustmentProperty[]`	A set of adjustments that enable you to scale based on the size of the alarm breach.
targetTrackingConfiguration?	`IResolvable` `\|` `TargetTrackingConfigurationProperty`	A target tracking scaling policy. Provides support for predefined or custom metrics.

autoScalingGroupName

Type: string

The name of the Auto Scaling group.

adjustmentType?

Type: string (optional)

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 in the Amazon EC2 Auto Scaling User Guide .

cooldown?

Type: string (optional)

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 in the Amazon EC2 Auto Scaling User Guide .

Default: None

estimatedInstanceWarmup?

Type: number (optional)

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.

metricAggregationType?

Type: string (optional)

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 .

minAdjustmentMagnitude?

Type: number (optional)

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

policyType?

Type: string (optional)

One of the following policy types:.

TargetTrackingScaling
StepScaling
SimpleScaling (default)
PredictiveScaling

predictiveScalingConfiguration?

Type: IResolvable | PredictiveScalingConfigurationProperty (optional)

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 .

scalingAdjustment?

Type: number (optional)

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.)

stepAdjustments?

Type: IResolvable | IResolvable | StepAdjustmentProperty[] (optional)

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.)

targetTrackingConfiguration?

Type: IResolvable | TargetTrackingConfigurationProperty (optional)

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 .