Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-autoscaling-scalingpolicy.json
Parent schema serverless-framework-configuration
Type: object

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.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-autoscaling.git

Properties

AutoScalingGroupName string | Aws_CF_FunctionString required

The name of the Auto Scaling group.

MetricAggregationType string | Aws_CF_FunctionString

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.

PolicyType string | Aws_CF_FunctionString

One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling

PredictiveScalingConfiguration object
5 nested properties
MetricSpecifications PredictiveScalingMetricSpecification[] required
uniqueItems=true
MaxCapacityBreachBehavior string | Aws_CF_FunctionString
MaxCapacityBuffer integer
SchedulingBufferTime integer
Mode string | Aws_CF_FunctionString
ScalingAdjustment integer

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 positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.)

Cooldown string | Aws_CF_FunctionString

The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.

StepAdjustments StepAdjustment[]

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

uniqueItems=true
MinAdjustmentMagnitude integer

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.

TargetTrackingConfiguration object
4 nested properties
TargetValue number required
CustomizedMetricSpecification object
5 nested properties
MetricName string | Aws_CF_FunctionString required
Statistic string | Aws_CF_FunctionString required
Namespace string | Aws_CF_FunctionString required
Dimensions MetricDimension[]
uniqueItems=true
Unit string | Aws_CF_FunctionString
DisableScaleIn boolean
PredefinedMetricSpecification object
2 nested properties
PredefinedMetricType string | Aws_CF_FunctionString required
ResourceLabel string | Aws_CF_FunctionString
EstimatedInstanceWarmup integer

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling.

AdjustmentType string | Aws_CF_FunctionString

Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Definitions

PredictiveScalingMetricSpecification object
TargetValue number required
CustomizedCapacityMetricSpecification object
1 nested properties
MetricDataQueries MetricDataQuery[] required
uniqueItems=true
CustomizedLoadMetricSpecification object
1 nested properties
MetricDataQueries MetricDataQuery[] required
uniqueItems=true
CustomizedScalingMetricSpecification object
1 nested properties
MetricDataQueries MetricDataQuery[] required
uniqueItems=true
PredefinedLoadMetricSpecification object
2 nested properties
PredefinedMetricType string | Aws_CF_FunctionString required
ResourceLabel string | Aws_CF_FunctionString
PredefinedScalingMetricSpecification object
2 nested properties
PredefinedMetricType string | Aws_CF_FunctionString required
ResourceLabel string | Aws_CF_FunctionString
PredefinedMetricPairSpecification object
2 nested properties
PredefinedMetricType string | Aws_CF_FunctionString required
ResourceLabel string | Aws_CF_FunctionString
PredictiveScalingConfiguration object
MetricSpecifications PredictiveScalingMetricSpecification[] required
uniqueItems=true
MaxCapacityBreachBehavior string | Aws_CF_FunctionString
MaxCapacityBuffer integer
SchedulingBufferTime integer
Mode string | Aws_CF_FunctionString
CustomizedMetricSpecification object
MetricName string | Aws_CF_FunctionString required
Statistic string | Aws_CF_FunctionString required
Namespace string | Aws_CF_FunctionString required
Dimensions MetricDimension[]
uniqueItems=true
Unit string | Aws_CF_FunctionString
TargetTrackingConfiguration object
TargetValue number required
CustomizedMetricSpecification object
5 nested properties
MetricName string | Aws_CF_FunctionString required
Statistic string | Aws_CF_FunctionString required
Namespace string | Aws_CF_FunctionString required
Dimensions MetricDimension[]
uniqueItems=true
Unit string | Aws_CF_FunctionString
DisableScaleIn boolean
PredefinedMetricSpecification object
2 nested properties
PredefinedMetricType string | Aws_CF_FunctionString required
ResourceLabel string | Aws_CF_FunctionString
PredictiveScalingPredefinedLoadMetric object
PredefinedMetricType string | Aws_CF_FunctionString required
ResourceLabel string | Aws_CF_FunctionString
StepAdjustment object
ScalingAdjustment integer required
MetricIntervalUpperBound number
MetricIntervalLowerBound number
PredictiveScalingPredefinedMetricPair object
PredefinedMetricType string | Aws_CF_FunctionString required
ResourceLabel string | Aws_CF_FunctionString
PredefinedMetricSpecification object
PredefinedMetricType string | Aws_CF_FunctionString required
ResourceLabel string | Aws_CF_FunctionString
MetricDimension object
Value string | Aws_CF_FunctionString required
Name string | Aws_CF_FunctionString required
PredictiveScalingPredefinedScalingMetric object
PredefinedMetricType string | Aws_CF_FunctionString required
ResourceLabel string | Aws_CF_FunctionString
PredictiveScalingCustomizedLoadMetric object
MetricDataQueries MetricDataQuery[] required
uniqueItems=true
PredictiveScalingCustomizedCapacityMetric object
MetricDataQueries MetricDataQuery[] required
uniqueItems=true
PredictiveScalingCustomizedScalingMetric object
MetricDataQueries MetricDataQuery[] required
uniqueItems=true
Metric object
MetricName string | Aws_CF_FunctionString required
Namespace string | Aws_CF_FunctionString required
Dimensions MetricDimension[]
uniqueItems=true
MetricStat object
Metric object required
3 nested properties
MetricName string | Aws_CF_FunctionString required
Namespace string | Aws_CF_FunctionString required
Dimensions MetricDimension[]
uniqueItems=true
Stat string | Aws_CF_FunctionString required
Unit string | Aws_CF_FunctionString
MetricDataQuery object
Id string | Aws_CF_FunctionString required
Label string | Aws_CF_FunctionString
MetricStat object
3 nested properties
Metric object required
3 nested properties
MetricName string | Aws_CF_FunctionString required
Namespace string | Aws_CF_FunctionString required
Dimensions MetricDimension[]
uniqueItems=true
Stat string | Aws_CF_FunctionString required
Unit string | Aws_CF_FunctionString
ReturnData boolean
Expression string | Aws_CF_FunctionString