Put Scaling Policy

autoscaling_put_scaling_policy

R Documentation

Creates or updates a scaling policy for an Auto Scaling group

Description

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 describe_policies API call. If you are no longer using a scaling policy, you can delete it by calling the delete_policy API.

Usage

autoscaling_put_scaling_policy(AutoScalingGroupName, PolicyName,
  PolicyType, AdjustmentType, MinAdjustmentStep, MinAdjustmentMagnitude,
  ScalingAdjustment, Cooldown, MetricAggregationType, StepAdjustments,
  EstimatedInstanceWarmup, TargetTrackingConfiguration, Enabled,
  PredictiveScalingConfiguration)

Arguments

AutoScalingGroupName	[required] The name of the Auto Scaling group.
PolicyName	[required] The name of the policy.
PolicyType	One of the following policy types: TargetTrackingScaling StepScaling SimpleScaling (default) PredictiveScaling
AdjustmentType	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.
MinAdjustmentStep	Available for backward compatibility. Use MinAdjustmentMagnitude instead.
MinAdjustmentMagnitude	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.
ScalingAdjustment	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.)
Cooldown	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
MetricAggregationType	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.
StepAdjustments	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.)
EstimatedInstanceWarmup	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.
TargetTrackingConfiguration	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. For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference. Required if the policy type is TargetTrackingScaling.
Enabled	Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disable a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
PredictiveScalingConfiguration	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. For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference. Required if the policy type is PredictiveScaling.

Value

A list with the following syntax:

list(
  PolicyARN = "string",
  Alarms = list(
    list(
      AlarmName = "string",
      AlarmARN = "string"
    )
  )
)

Request syntax

svc$put_scaling_policy(
  AutoScalingGroupName = "string",
  PolicyName = "string",
  PolicyType = "string",
  AdjustmentType = "string",
  MinAdjustmentStep = 123,
  MinAdjustmentMagnitude = 123,
  ScalingAdjustment = 123,
  Cooldown = 123,
  MetricAggregationType = "string",
  StepAdjustments = list(
    list(
      MetricIntervalLowerBound = 123.0,
      MetricIntervalUpperBound = 123.0,
      ScalingAdjustment = 123
    )
  ),
  EstimatedInstanceWarmup = 123,
  TargetTrackingConfiguration = list(
    PredefinedMetricSpecification = list(
      PredefinedMetricType = "ASGAverageCPUUtilization"|"ASGAverageNetworkIn"|"ASGAverageNetworkOut"|"ALBRequestCountPerTarget",
      ResourceLabel = "string"
    ),
    CustomizedMetricSpecification = list(
      MetricName = "string",
      Namespace = "string",
      Dimensions = list(
        list(
          Name = "string",
          Value = "string"
        )
      ),
      Statistic = "Average"|"Minimum"|"Maximum"|"SampleCount"|"Sum",
      Unit = "string",
      Period = 123,
      Metrics = list(
        list(
          Id = "string",
          Expression = "string",
          MetricStat = list(
            Metric = list(
              Namespace = "string",
              MetricName = "string",
              Dimensions = list(
                list(
                  Name = "string",
                  Value = "string"
                )
              )
            ),
            Stat = "string",
            Unit = "string",
            Period = 123
          ),
          Label = "string",
          Period = 123,
          ReturnData = TRUE|FALSE
        )
      )
    ),
    TargetValue = 123.0,
    DisableScaleIn = TRUE|FALSE
  ),
  Enabled = TRUE|FALSE,
  PredictiveScalingConfiguration = list(
    MetricSpecifications = list(
      list(
        TargetValue = 123.0,
        PredefinedMetricPairSpecification = list(
          PredefinedMetricType = "ASGCPUUtilization"|"ASGNetworkIn"|"ASGNetworkOut"|"ALBRequestCount",
          ResourceLabel = "string"
        ),
        PredefinedScalingMetricSpecification = list(
          PredefinedMetricType = "ASGAverageCPUUtilization"|"ASGAverageNetworkIn"|"ASGAverageNetworkOut"|"ALBRequestCountPerTarget",
          ResourceLabel = "string"
        ),
        PredefinedLoadMetricSpecification = list(
          PredefinedMetricType = "ASGTotalCPUUtilization"|"ASGTotalNetworkIn"|"ASGTotalNetworkOut"|"ALBTargetGroupRequestCount",
          ResourceLabel = "string"
        ),
        CustomizedScalingMetricSpecification = list(
          MetricDataQueries = list(
            list(
              Id = "string",
              Expression = "string",
              MetricStat = list(
                Metric = list(
                  Namespace = "string",
                  MetricName = "string",
                  Dimensions = list(
                    list(
                      Name = "string",
                      Value = "string"
                    )
                  )
                ),
                Stat = "string",
                Unit = "string"
              ),
              Label = "string",
              ReturnData = TRUE|FALSE
            )
          )
        ),
        CustomizedLoadMetricSpecification = list(
          MetricDataQueries = list(
            list(
              Id = "string",
              Expression = "string",
              MetricStat = list(
                Metric = list(
                  Namespace = "string",
                  MetricName = "string",
                  Dimensions = list(
                    list(
                      Name = "string",
                      Value = "string"
                    )
                  )
                ),
                Stat = "string",
                Unit = "string"
              ),
              Label = "string",
              ReturnData = TRUE|FALSE
            )
          )
        ),
        CustomizedCapacityMetricSpecification = list(
          MetricDataQueries = list(
            list(
              Id = "string",
              Expression = "string",
              MetricStat = list(
                Metric = list(
                  Namespace = "string",
                  MetricName = "string",
                  Dimensions = list(
                    list(
                      Name = "string",
                      Value = "string"
                    )
                  )
                ),
                Stat = "string",
                Unit = "string"
              ),
              Label = "string",
              ReturnData = TRUE|FALSE
            )
          )
        )
      )
    ),
    Mode = "ForecastAndScale"|"ForecastOnly",
    SchedulingBufferTime = 123,
    MaxCapacityBreachBehavior = "HonorMaxCapacity"|"IncreaseMaxCapacity",
    MaxCapacityBuffer = 123
  )
)

Examples

## Not run: 
# This example adds the specified policy to the specified Auto Scaling
# group.
svc$put_scaling_policy(
  AutoScalingGroupName = "my-auto-scaling-group",
  PolicyName = "alb1000-target-tracking-scaling-policy",
  PolicyType = "TargetTrackingScaling",
  TargetTrackingConfiguration = list(
    PredefinedMetricSpecification = list(
      PredefinedMetricType = "ALBRequestCountPerTarget",
      ResourceLabel = "app/my-alb/778d41231b141a0f/targetgroup/my-alb-targe..."
    ),
    TargetValue = 1000
  )
)

## End(Not run)