Creates a scaling plan.
" + "documentation":"Creates a scaling plan.
" }, "DeleteScalingPlan":{ "name":"DeleteScalingPlan", @@ -150,11 +150,11 @@ }, "ApplicationSource":{ "shape":"ApplicationSource", - "documentation":"A CloudFormation stack or set of tags. You can create one scaling plan per application source.
" + "documentation":"A CloudFormation stack or set of tags. You can create one scaling plan per application source.
For more information, see ApplicationSource in the AWS Auto Scaling API Reference.
" }, "ScalingInstructions":{ "shape":"ScalingInstructions", - "documentation":"The scaling instructions.
" + "documentation":"The scaling instructions.
For more information, see ScalingInstruction in the AWS Auto Scaling API Reference.
" } } }, @@ -164,7 +164,7 @@ "members":{ "ScalingPlanVersion":{ "shape":"ScalingPlanVersion", - "documentation":"The version number of the scaling plan. This value is always 1.
Currently, you cannot specify multiple scaling plan versions.
" + "documentation":"The version number of the scaling plan. This value is always 1. Currently, you cannot have multiple scaling plan versions.
The statistic of the metric. Currently, the value must always be Sum.
The statistic of the metric. The only valid value is Sum.
The unit of the metric.
" } }, - "documentation":"Represents a CloudWatch metric of your choosing that can be used for predictive scaling.
For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch computes from metric data. Statistics are calculations used to aggregate data over specified time periods.
When you choose a load metric, make sure that the required Sum and Average statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum statistic must represent the total load on the resource, and the Average statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum statistic represents the total request count processed by the group, then the Average statistic for the specified metric must represent the average request count processed by each instance of the group.
For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.
" + "documentation":"Represents a CloudWatch metric of your choosing that can be used for predictive scaling.
For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch computes from metric data.
When you choose a load metric, make sure that the required Sum and Average statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum statistic must represent the total load on the resource, and the Average statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum statistic represents the total request count processed by the group, then the Average statistic for the specified metric must represent the average request count processed by each instance of the group.
If you publish your own metrics, you can aggregate the data points at a given interval and then publish the aggregated data points to CloudWatch. Before AWS Auto Scaling generates the forecast, it sums up all the metric data points that occurred within each hour to match the granularity period that is used in the forecast (60 minutes).
For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.
After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource in the AWS Auto Scaling User Guide.
" }, "CustomizedScalingMetricSpecification":{ "type":"structure", @@ -228,7 +228,7 @@ "documentation":"The unit of the metric.
" } }, - "documentation":"Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part of a target tracking scaling policy.
To create your customized scaling metric specification:
Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.
Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.
For more information about CloudWatch, see Amazon CloudWatch Concepts.
" + "documentation":"Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part of a target tracking scaling policy.
To create your customized scaling metric specification:
Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.
Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.
For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.
" }, "Datapoint":{ "type":"structure", @@ -261,7 +261,7 @@ }, "ScalingPlanVersion":{ "shape":"ScalingPlanVersion", - "documentation":"The version number of the scaling plan.
" + "documentation":"The version number of the scaling plan. Currently, the only valid value is 1.
The version number of the scaling plan.
" + "documentation":"The version number of the scaling plan. Currently, the only valid value is 1.
The version number of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name.
" + "documentation":"The version number of the scaling plan. Currently, the only valid value is 1.
If you specify a scaling plan version, you must also specify a scaling plan name.
The version number of the scaling plan.
" + "documentation":"The version number of the scaling plan. Currently, the only valid value is 1.
The namespace of the AWS service.
" + "documentation":"The namespace of the AWS service. The only valid value is autoscaling.
The ID of the resource. This string consists of the resource type and unique identifier.
Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the name of a specified Auto Scaling group (my-asg). Example: autoScalingGroup/my-asg.
The scalable dimension for the resource.
" + "documentation":"The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.
Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group.
The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
" } }, - "documentation":"Represents a predefined metric that can be used for predictive scaling.
" + "documentation":"Represents a predefined metric that can be used for predictive scaling.
After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource in the AWS Auto Scaling User Guide.
" }, "PredefinedScalingMetricSpecification":{ "type":"structure", @@ -531,7 +531,7 @@ }, "ResourceLabel":{ "shape":"ResourceLabel", - "documentation":"Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.
The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
" } }, "documentation":"Represents a predefined metric that can be used for dynamic scaling as part of a target tracking scaling policy.
" @@ -609,7 +609,7 @@ }, "TargetTrackingConfigurations":{ "shape":"TargetTrackingConfigurations", - "documentation":"The structure that defines new target tracking configurations (up to 10). Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling.
With predictive scaling and dynamic scaling, the resource scales based on the target tracking configuration that provides the largest capacity for both scale in and scale out.
Condition: The scaling metric must be unique across target tracking configurations.
" + "documentation":"The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.
" }, "PredefinedLoadMetricSpecification":{ "shape":"PredefinedLoadMetricSpecification", @@ -644,7 +644,7 @@ "documentation":"Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.
The default is enabled (false).
Describes a scaling instruction for a scalable resource.
The scaling instruction is used in combination with a scaling plan, which is a set of instructions for configuring dynamic scaling and predictive scaling for the scalable resources in your application. Each scaling instruction applies to one resource.
AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.
AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of parameters, including the load metric, the scaling metric, the target value for the scaling metric, the predictive scaling mode (forecast and scale or forecast only), and the desired behavior when the forecast capacity exceeds the maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to match the forecast.
We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At minimum, there must be 24 hours of historical data to generate a forecast.
For more information, see Getting Started with AWS Auto Scaling.
" + "documentation":"Describes a scaling instruction for a scalable resource in a scaling plan. Each scaling instruction applies to one resource.
AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.
AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of parameters, including the load metric, the scaling metric, the target value for the scaling metric, the predictive scaling mode (forecast and scale or forecast only), and the desired behavior when the forecast capacity exceeds the maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to match the forecast.
We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At minimum, there must be 24 hours of historical data to generate a forecast. For more information, see Best Practices for AWS Auto Scaling in the AWS Auto Scaling User Guide.
The application source.
" + "documentation":"A CloudFormation stack or a set of tags. You can create one scaling plan per application source.
" }, "ScalingInstructions":{ "shape":"ScalingInstructions", @@ -882,7 +882,7 @@ }, "TargetValue":{ "shape":"MetricScale", - "documentation":"The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
" + "documentation":"The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360.
" }, "DisableScaleIn":{ "shape":"DisableScaleIn", @@ -890,11 +890,11 @@ }, "ScaleOutCooldown":{ "shape":"Cooldown", - "documentation":"The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.
While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.
" + "documentation":"The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.
" }, "ScaleInCooldown":{ "shape":"Cooldown", - "documentation":"The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.
The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, AWS Auto Scaling scales out your scalable target immediately.
" + "documentation":"The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
" }, "EstimatedInstanceWarmup":{ "shape":"Cooldown", @@ -921,15 +921,15 @@ }, "ScalingPlanVersion":{ "shape":"ScalingPlanVersion", - "documentation":"The version number of the scaling plan.
" + "documentation":"The version number of the scaling plan. The only valid value is 1. Currently, you cannot have multiple scaling plan versions.
A CloudFormation stack or set of tags.
" + "documentation":"A CloudFormation stack or set of tags.
For more information, see ApplicationSource in the AWS Auto Scaling API Reference.
" }, "ScalingInstructions":{ "shape":"ScalingInstructions", - "documentation":"The scaling instructions.
" + "documentation":"The scaling instructions.
For more information, see ScalingInstruction in the AWS Auto Scaling API Reference.
" } } }, @@ -963,5 +963,5 @@ "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" } }, - "documentation":"Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling and predictive scaling for your resources using scaling plans. Use this service in conjunction with the Amazon EC2 Auto Scaling, Application Auto Scaling, Amazon CloudWatch, and AWS CloudFormation services.
Currently, predictive scaling is only available for Amazon EC2 Auto Scaling groups.
For more information about AWS Auto Scaling, including information about granting IAM users required permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide.
" + "documentation":"Use AWS Auto Scaling to create scaling plans for your applications to automatically scale your scalable AWS resources.
API Summary
You can use the AWS Auto Scaling service API to accomplish the following tasks:
Create and manage scaling plans
Define target tracking scaling policies to dynamically scale your resources based on utilization
Scale Amazon EC2 Auto Scaling groups using predictive scaling and dynamic scaling to scale your Amazon EC2 capacity faster
Set minimum and maximum capacity limits
Retrieve information on existing scaling plans
Access current forecast data and historical forecast data for up to 56 days previous
To learn more about AWS Auto Scaling, including information about granting IAM users required permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide.
" }