Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

PutScalingPolicyCommand

Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.

For more information about using dynamic scaling, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AutoScalingClient, PutScalingPolicyCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import
// const { AutoScalingClient, PutScalingPolicyCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import
const client = new AutoScalingClient(config);
const input = { // PutScalingPolicyType
  AutoScalingGroupName: "STRING_VALUE", // required
  PolicyName: "STRING_VALUE", // required
  PolicyType: "STRING_VALUE",
  AdjustmentType: "STRING_VALUE",
  MinAdjustmentStep: Number("int"),
  MinAdjustmentMagnitude: Number("int"),
  ScalingAdjustment: Number("int"),
  Cooldown: Number("int"),
  MetricAggregationType: "STRING_VALUE",
  StepAdjustments: [ // StepAdjustments
    { // StepAdjustment
      MetricIntervalLowerBound: Number("double"),
      MetricIntervalUpperBound: Number("double"),
      ScalingAdjustment: Number("int"), // required
    },
  ],
  EstimatedInstanceWarmup: Number("int"),
  TargetTrackingConfiguration: { // TargetTrackingConfiguration
    PredefinedMetricSpecification: { // PredefinedMetricSpecification
      PredefinedMetricType: "ASGAverageCPUUtilization" || "ASGAverageNetworkIn" || "ASGAverageNetworkOut" || "ALBRequestCountPerTarget", // required
      ResourceLabel: "STRING_VALUE",
    },
    CustomizedMetricSpecification: { // CustomizedMetricSpecification
      MetricName: "STRING_VALUE",
      Namespace: "STRING_VALUE",
      Dimensions: [ // MetricDimensions
        { // MetricDimension
          Name: "STRING_VALUE", // required
          Value: "STRING_VALUE", // required
        },
      ],
      Statistic: "Average" || "Minimum" || "Maximum" || "SampleCount" || "Sum",
      Unit: "STRING_VALUE",
      Period: Number("int"),
      Metrics: [ // TargetTrackingMetricDataQueries
        { // TargetTrackingMetricDataQuery
          Id: "STRING_VALUE", // required
          Expression: "STRING_VALUE",
          MetricStat: { // TargetTrackingMetricStat
            Metric: { // Metric
              Namespace: "STRING_VALUE", // required
              MetricName: "STRING_VALUE", // required
              Dimensions: [
                {
                  Name: "STRING_VALUE", // required
                  Value: "STRING_VALUE", // required
                },
              ],
            },
            Stat: "STRING_VALUE", // required
            Unit: "STRING_VALUE",
            Period: Number("int"),
          },
          Label: "STRING_VALUE",
          Period: Number("int"),
          ReturnData: true || false,
        },
      ],
    },
    TargetValue: Number("double"), // required
    DisableScaleIn: true || false,
  },
  Enabled: true || false,
  PredictiveScalingConfiguration: { // PredictiveScalingConfiguration
    MetricSpecifications: [ // PredictiveScalingMetricSpecifications // required
      { // PredictiveScalingMetricSpecification
        TargetValue: Number("double"), // required
        PredefinedMetricPairSpecification: { // PredictiveScalingPredefinedMetricPair
          PredefinedMetricType: "ASGCPUUtilization" || "ASGNetworkIn" || "ASGNetworkOut" || "ALBRequestCount", // required
          ResourceLabel: "STRING_VALUE",
        },
        PredefinedScalingMetricSpecification: { // PredictiveScalingPredefinedScalingMetric
          PredefinedMetricType: "ASGAverageCPUUtilization" || "ASGAverageNetworkIn" || "ASGAverageNetworkOut" || "ALBRequestCountPerTarget", // required
          ResourceLabel: "STRING_VALUE",
        },
        PredefinedLoadMetricSpecification: { // PredictiveScalingPredefinedLoadMetric
          PredefinedMetricType: "ASGTotalCPUUtilization" || "ASGTotalNetworkIn" || "ASGTotalNetworkOut" || "ALBTargetGroupRequestCount", // required
          ResourceLabel: "STRING_VALUE",
        },
        CustomizedScalingMetricSpecification: { // PredictiveScalingCustomizedScalingMetric
          MetricDataQueries: [ // MetricDataQueries // required
            { // MetricDataQuery
              Id: "STRING_VALUE", // required
              Expression: "STRING_VALUE",
              MetricStat: { // MetricStat
                Metric: {
                  Namespace: "STRING_VALUE", // required
                  MetricName: "STRING_VALUE", // required
                  Dimensions: "<MetricDimensions>",
                },
                Stat: "STRING_VALUE", // required
                Unit: "STRING_VALUE",
              },
              Label: "STRING_VALUE",
              ReturnData: true || false,
            },
          ],
        },
        CustomizedLoadMetricSpecification: { // PredictiveScalingCustomizedLoadMetric
          MetricDataQueries: [ // required
            {
              Id: "STRING_VALUE", // required
              Expression: "STRING_VALUE",
              MetricStat: {
                Metric: {
                  Namespace: "STRING_VALUE", // required
                  MetricName: "STRING_VALUE", // required
                  Dimensions: "<MetricDimensions>",
                },
                Stat: "STRING_VALUE", // required
                Unit: "STRING_VALUE",
              },
              Label: "STRING_VALUE",
              ReturnData: true || false,
            },
          ],
        },
        CustomizedCapacityMetricSpecification: { // PredictiveScalingCustomizedCapacityMetric
          MetricDataQueries: [ // required
            {
              Id: "STRING_VALUE", // required
              Expression: "STRING_VALUE",
              MetricStat: {
                Metric: {
                  Namespace: "STRING_VALUE", // required
                  MetricName: "STRING_VALUE", // required
                  Dimensions: "<MetricDimensions>",
                },
                Stat: "STRING_VALUE", // required
                Unit: "STRING_VALUE",
              },
              Label: "STRING_VALUE",
              ReturnData: true || false,
            },
          ],
        },
      },
    ],
    Mode: "ForecastAndScale" || "ForecastOnly",
    SchedulingBufferTime: Number("int"),
    MaxCapacityBreachBehavior: "HonorMaxCapacity" || "IncreaseMaxCapacity",
    MaxCapacityBuffer: Number("int"),
  },
};
const command = new PutScalingPolicyCommand(input);
const response = await client.send(command);
// { // PolicyARNType
//   PolicyARN: "STRING_VALUE",
//   Alarms: [ // Alarms
//     { // Alarm
//       AlarmName: "STRING_VALUE",
//       AlarmARN: "STRING_VALUE",
//     },
//   ],
// };

Example Usage

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
// This example adds the specified policy to the specified Auto Scaling group.
const input = {
  "AutoScalingGroupName": "my-auto-scaling-group",
  "PolicyName": "alb1000-target-tracking-scaling-policy",
  "PolicyType": "TargetTrackingScaling",
  "TargetTrackingConfiguration": {
    "PredefinedMetricSpecification": {
      "PredefinedMetricType": "ALBRequestCountPerTarget",
      "ResourceLabel": "app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff"
    },
    "TargetValue": 1000
  }
};
const command = new PutScalingPolicyCommand(input);
const response = await client.send(command);
/* response ==
{
  "Alarms": [
    {
      "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac
          -497e-9992-691c9980c38e",
      "AlarmName": "TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e"
    },
    {
      "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-61a39305-ed0c
          -47af-bd9e-471a352ee1a2",
      "AlarmName": "TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2"
    }
  ],
  "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:228f02c2-c665-4bfd-aaac-8b04080bea3c
      :autoScalingGroupName/my-auto-scaling-group:policyName/alb1000-target-tracking-scaling-policy"
}
*\/
// example id: autoscaling-put-scaling-policy-1
 
 
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

JavaScriptLn 1, Col 1

Errors: 0 Warnings: 0