Expand description
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.
If you’re using the service, you’re probably looking for AutoscalingPlansClient and AutoscalingPlans.
Structs§
- Application
Source Represents an application source.
- Autoscaling
Plans Client - A client for the AWS Auto Scaling Plans API.
- Create
Scaling Plan Request - Create
Scaling Plan Response - Customized
Load Metric Specification 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
SumandAveragestatistics that CloudWatch computes from metric data.When you choose a load metric, make sure that the required
SumandAveragestatistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. TheSumstatistic must represent the total load on the resource, and theAveragestatistic 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 theSumstatistic represents the total request count processed by the group, then theAveragestatistic 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.
- Customized
Scaling Metric Specification 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
Represents a single value in the forecast data used for predictive scaling.
- Delete
Scaling Plan Request - Delete
Scaling Plan Response - Describe
Scaling Plan Resources Request - Describe
Scaling Plan Resources Response - Describe
Scaling Plans Request - Describe
Scaling Plans Response - GetScaling
Plan Resource Forecast Data Request - GetScaling
Plan Resource Forecast Data Response - Metric
Dimension Represents a dimension for a customized metric.
- Predefined
Load Metric Specification 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.
- Predefined
Scaling Metric Specification Represents a predefined metric that can be used for dynamic scaling as part of a target tracking scaling policy.
- Scaling
Instruction 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.
- Scaling
Plan Represents a scaling plan.
- Scaling
Plan Resource Represents a scalable resource.
- Scaling
Policy Represents a scaling policy.
- TagFilter
Represents a tag.
- Target
Tracking Configuration Describes a target tracking configuration to use with AWS Auto Scaling. Used with ScalingInstruction and ScalingPolicy.
- Update
Scaling Plan Request - Update
Scaling Plan Response
Enums§
- Create
Scaling Plan Error - Errors returned by CreateScalingPlan
- Delete
Scaling Plan Error - Errors returned by DeleteScalingPlan
- Describe
Scaling Plan Resources Error - Errors returned by DescribeScalingPlanResources
- Describe
Scaling Plans Error - Errors returned by DescribeScalingPlans
- GetScaling
Plan Resource Forecast Data Error - Errors returned by GetScalingPlanResourceForecastData
- Update
Scaling Plan Error - Errors returned by UpdateScalingPlan
Traits§
- Autoscaling
Plans - Trait representing the capabilities of the AWS Auto Scaling Plans API. AWS Auto Scaling Plans clients implement this trait.