Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.
For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: autoscaling x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/autoscaling-2011-01-01.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://autoscaling.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Auto Scaling multi-region endpoint - url: https://autoscaling.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Auto Scaling multi-region endpoint - url: http://autoscaling.amazonaws.com variables: {} description: The general Auto Scaling endpoint for US East (N. Virginia) - url: https://autoscaling.amazonaws.com variables: {} description: The general Auto Scaling endpoint for US East (N. Virginia) - url: http://autoscaling.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Auto Scaling endpoint for China (Beijing) and China (Ningxia) - url: https://autoscaling.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Auto Scaling endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#Action=DescribePolicies' paths: /#Action=DescribePolicies: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: x-aws-operation-name: DescribePolicies operationId: GET_DescribePolicies description: Gets information about the scaling policies in the account and Region. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/PoliciesType' examples: GET_DescribePolicies200Example: summary: Default GET_DescribePolicies 200 response x-microcks-default: true value: ScalingPolicies: example-string NextToken: example-string '480': description: InvalidNextToken content: text/xml: schema: $ref: '#/components/schemas/InvalidNextToken' examples: GET_DescribePolicies480Example: summary: Default GET_DescribePolicies 480 response x-microcks-default: true value: {} '481': description: ResourceContentionFault content: text/xml: schema: $ref: '#/components/schemas/ResourceContentionFault' examples: GET_DescribePolicies481Example: summary: Default GET_DescribePolicies 481 response x-microcks-default: true value: {} '482': description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: '#/components/schemas/ServiceLinkedRoleFailure' parameters: - name: AutoScalingGroupName in: query required: false description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' - name: PolicyNames in: query required: false description: 'The names of one or more policies. If you omit this property, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.
Array Members: Maximum number of 50 items.
' schema: type: array items: $ref: '#/components/schemas/ResourceName' - name: PolicyTypes in: query required: false description: One or more policy types. The valid values areSimpleScaling, StepScaling, TargetTrackingScaling, and PredictiveScaling.
schema:
type: array
items:
$ref: '#/components/schemas/XmlStringMaxLen64'
- name: NextToken
in: query
required: false
description: The token for the next set of items to return. (You received this token from a previous call.)
schema:
type: string
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: MaxRecords
in: query
required: false
description: The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribePolicies
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Policies
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=DescribePolicies'
post:
x-aws-operation-name: DescribePolicies
operationId: POST_DescribePolicies
description: Gets information about the scaling policies in the account and Region.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/PoliciesType'
examples:
POST_DescribePolicies200Example:
summary: Default POST_DescribePolicies 200 response
x-microcks-default: true
value:
ScalingPolicies: example-string
NextToken: example-string
'480':
description: InvalidNextToken
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidNextToken'
examples:
POST_DescribePolicies480Example:
summary: Default POST_DescribePolicies 480 response
x-microcks-default: true
value: {}
'481':
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ResourceContentionFault'
examples:
POST_DescribePolicies481Example:
summary: Default POST_DescribePolicies 481 response
x-microcks-default: true
value: {}
'482':
description: ServiceLinkedRoleFailure
content:
text/xml:
schema:
$ref: '#/components/schemas/ServiceLinkedRoleFailure'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribePoliciesType'
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribePolicies
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling POST_ Describe Policies
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=DescribePolicies'
components:
schemas:
XmlString:
type: string
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
MetricStat:
type: object
required:
- Metric
- Stat
properties:
Metric:
allOf:
- $ref: '#/components/schemas/Metric'
- description: The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
Stat:
allOf:
- $ref: '#/components/schemas/XmlStringMetricStat'
- description: The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
The most commonly used metrics for predictive scaling are Average and Sum.
This structure defines the CloudWatch metric to return, along with the statistic, period, and unit.
For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts in the Amazon CloudWatch User Guide.
TargetTrackingConfiguration: type: object required: - TargetValue properties: PredefinedMetricSpecification: allOf: - $ref: '#/components/schemas/PredefinedMetricSpecification' - description: A predefined metric. You must specify either a predefined metric or a customized metric. CustomizedMetricSpecification: allOf: - $ref: '#/components/schemas/CustomizedMetricSpecification' - description: A customized metric. You must specify either a predefined metric or a customized metric. TargetValue: allOf: - $ref: '#/components/schemas/MetricScale' - description:The target value for the metric.
Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.
false.
description: Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.
MetricDataQueries:
type: array
items:
$ref: '#/components/schemas/MetricDataQuery'
PolicyNames:
type: array
items:
$ref: '#/components/schemas/ResourceName'
PolicyIncrement:
type: integer
PredefinedScalingMetricType:
type: string
enum:
- ASGAverageCPUUtilization
- ASGAverageNetworkIn
- ASGAverageNetworkOut
- ALBRequestCountPerTarget
MetricName:
type: string
MetricDimensions:
type: array
items:
$ref: '#/components/schemas/MetricDimension'
PredictiveScalingMaxCapacityBuffer:
type: integer
minimum: 0
maximum: 100
PredefinedMetricSpecification:
type: object
required:
- PredefinedMetricType
properties:
PredefinedMetricType:
allOf:
- $ref: '#/components/schemas/MetricType'
- description: The metric type. The following predefined metrics are available:
ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.
ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.
ALBRequestCountPerTarget - Average Application Load Balancer request count per target for your Auto Scaling group.
A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is 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 of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
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.
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.
description: Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling. MetricNamespace: type: string MetricDimensionName: type: string MinAdjustmentStep: type: integer deprecated: true ResourceContentionFault: {} XmlStringMaxLen64: type: string minLength: 1 maxLength: 64 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' EstimatedInstanceWarmup: type: integer XmlStringMaxLen1023: type: string minLength: 1 maxLength: 1023 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' PredictiveScalingPredefinedMetricPair: type: object required: - PredefinedMetricType properties: PredefinedMetricType: allOf: - $ref: '#/components/schemas/PredefinedMetricPairType' - description: 'Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric. For example, if the metric type isASGCPUUtilization, the Auto Scaling group''s total CPU metric is used as the load metric, and the average CPU metric is used for the scaling metric.'
ResourceLabel:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen1023'
- description: A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is 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 of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
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.
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.
description: 'Represents a metric pair for a predictive scaling policy. ' XmlStringMaxLen32: type: string minLength: 1 maxLength: 32 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' XmlStringMetricStat: type: string minLength: 1 maxLength: 100 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' StepAdjustments: type: array items: $ref: '#/components/schemas/StepAdjustment' PredictiveScalingCustomizedCapacityMetric: type: object required: - MetricDataQueries properties: MetricDataQueries: allOf: - $ref: '#/components/schemas/MetricDataQueries' - description: 'One or more metric data queries to provide the data points for a capacity metric. Use multiple metric data queries only if you are performing a math expression on returned data. ' description: Describes a customized capacity metric for a predictive scaling policy. MetricDimension: type: object required: - Name - Value properties: Name: allOf: - $ref: '#/components/schemas/MetricDimensionName' - description: The name of the dimension. Value: allOf: - $ref: '#/components/schemas/MetricDimensionValue' - description: The value of the dimension. description: Describes the dimension of a metric. PredefinedLoadMetricType: type: string enum: - ASGTotalCPUUtilization - ASGTotalNetworkIn - ASGTotalNetworkOut - ALBTargetGroupRequestCount MinAdjustmentMagnitude: type: integer MetricDimensionValue: type: string PredictiveScalingPredefinedLoadMetric: type: object required: - PredefinedMetricType properties: PredefinedMetricType: allOf: - $ref: '#/components/schemas/PredefinedLoadMetricType' - description: The metric type. ResourceLabel: allOf: - $ref: '#/components/schemas/XmlStringMaxLen1023' - description:A label that uniquely identifies a specific Application Load Balancer target group from which to determine the request count served by your Auto Scaling group. You can't specify a resource label unless the target group is 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 of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
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.
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.
description:Describes a load metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.
The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
The upper bound must be greater than the lower bound.
ScalingAdjustment: allOf: - $ref: '#/components/schemas/PolicyIncrement' - description: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.
The amount by which to scale. The adjustment is based on the value that you specified in the AdjustmentType property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity.
Describes information used to create a step adjustment for a step scaling policy.
For the following examples, suppose that you have an alarm with a breach threshold of 50:
To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.
To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.
There are a few rules for the step adjustments for your step policy:
The ranges of your step adjustments can't overlap or have a gap.
At most, one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.
At most, one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.
The upper and lower bound can't be null in the same step adjustment.
For more information, see Step adjustments in the Amazon EC2 Auto Scaling User Guide.
MaxRecords: type: integer MetricUnit: type: string Alarm: type: object properties: AlarmName: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: The name of the alarm. AlarmARN: allOf: - $ref: '#/components/schemas/ResourceName' - description: The Amazon Resource Name (ARN) of the alarm. description: Describes an alarm. TargetTrackingMetricStat: type: object required: - Metric - Stat properties: Metric: allOf: - $ref: '#/components/schemas/Metric' - description: The metric to use. Stat: allOf: - $ref: '#/components/schemas/XmlStringMetricStat' - description:The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
The most commonly used metric for scaling is Average.
This structure defines the CloudWatch metric to return, along with the statistic and unit.
For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts in the Amazon CloudWatch User Guide.
PredictiveScalingSchedulingBufferTime: type: integer minimum: 0 MetricType: type: string enum: - ASGAverageCPUUtilization - ASGAverageNetworkIn - ASGAverageNetworkOut - ALBRequestCountPerTarget Metric: type: object required: - Namespace - MetricName properties: Namespace: allOf: - $ref: '#/components/schemas/MetricNamespace' - description: The namespace of the metric. For more information, see the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide. MetricName: allOf: - $ref: '#/components/schemas/MetricName' - description: The name of the metric. Dimensions: allOf: - $ref: '#/components/schemas/MetricDimensions' - description: 'The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
' description: 'Represents a specific metric. ' Cooldown: type: integer PredictiveScalingMetricSpecifications: type: array items: $ref: '#/components/schemas/PredictiveScalingMetricSpecification' TargetTrackingMetricDataQuery: type: object required: - Id properties: Id: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: 'A short name that identifies the object''s results in the response. This name must be unique among allTargetTrackingMetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter. '
Expression:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen2047'
- description: 'The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.
Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.
Information about the metric data to return.
Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).
NextToken value when requesting the next set of items. This value is null when there are no more items to return.
example: example-string
PredictiveScalingMetricSpecification:
type: object
required:
- TargetValue
properties:
TargetValue:
allOf:
- $ref: '#/components/schemas/MetricScale'
- description: Specifies the target utilization.
Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.
This structure specifies the metrics and target utilization settings for a predictive scaling policy.
You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.
Example
You create a predictive scaling policy and specify ALBRequestCount as the value for the metric pair and 1000.0 as the target value. For this type of metric, you must provide the metric dimension for the corresponding target group, so you also provide a resource label for the Application Load Balancer target group that is attached to your Auto Scaling group.
The number of requests the target group receives per minute provides the load metric, and the request count averaged between the members of the target group provides the scaling metric. In CloudWatch, this refers to the RequestCount and RequestCountPerTarget metrics, respectively.
For optimal use of predictive scaling, you adhere to the best practice of using a dynamic scaling policy to automatically scale between the minimum capacity and maximum capacity in response to real-time changes in resource utilization.
Amazon EC2 Auto Scaling consumes data points for the load metric over the last 14 days and creates an hourly load forecast for predictive scaling. (A minimum of 24 hours of data is required.)
After creating the load forecast, Amazon EC2 Auto Scaling determines when to reduce or increase the capacity of your Auto Scaling group in each hour of the forecast period so that the average number of requests received by each instance is as close to 1000 requests per minute as possible at all times.
For information about using custom metrics with predictive scaling, see Advanced predictive scaling policy configurations using custom metrics in the Amazon EC2 Auto Scaling User Guide.
ScalingPolicyEnabled: type: boolean PredictiveScalingCustomizedScalingMetric: type: object required: - MetricDataQueries properties: MetricDataQueries: allOf: - $ref: '#/components/schemas/MetricDataQueries' - description: 'One or more metric data queries to provide the data points for a scaling metric. Use multiple metric data queries only if you are performing a math expression on returned data. ' description: Describes a custom scaling metric for a predictive scaling policy. XmlStringMetricLabel: type: string maxLength: 2047 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' MetricScale: type: number format: double PolicyTypes: type: array items: $ref: '#/components/schemas/XmlStringMaxLen64' InvalidNextToken: {} XmlStringMaxLen2047: type: string minLength: 1 maxLength: 2047 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' MetricDataQuery: type: object required: - Id properties: Id: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: 'A short name that identifies the object''s results in the response. This name must be unique among allMetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter. '
Expression:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen1023'
- description: 'The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.
Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
Information about the metric data to return.
Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).
The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.
For more information and examples, see Advanced predictive scaling policy configurations using custom metrics in the Amazon EC2 Auto Scaling User Guide.
DisableScaleIn: type: boolean PredefinedMetricPairType: type: string enum: - ASGCPUUtilization - ASGNetworkIn - ASGNetworkOut - ALBRequestCount PredictiveScalingConfiguration: type: object required: - MetricSpecifications properties: MetricSpecifications: allOf: - $ref: '#/components/schemas/PredictiveScalingMetricSpecifications' - description:This structure includes the metrics and target utilization to use for predictive scaling.
This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
Mode: allOf: - $ref: '#/components/schemas/PredictiveScalingMode' - description: The predictive scaling mode. Defaults toForecastOnly if not specified.
SchedulingBufferTime:
allOf:
- $ref: '#/components/schemas/PredictiveScalingSchedulingBufferTime'
- description: The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
MaxCapacityBreachBehavior: allOf: - $ref: '#/components/schemas/PredictiveScalingMaxCapacityBreachBehavior' - description:Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.
The following are possible values:
HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.
IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.
The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.
Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.
One of the following policy types:
TargetTrackingScaling
StepScaling
SimpleScaling (default)
PredictiveScaling
For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
' AdjustmentType: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values areChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
MinAdjustmentStep:
allOf:
- $ref: '#/components/schemas/MinAdjustmentStep'
- description: Available for backward compatibility. Use MinAdjustmentMagnitude instead.
MinAdjustmentMagnitude:
allOf:
- $ref: '#/components/schemas/MinAdjustmentMagnitude'
- description: 'The minimum value to scale by when the adjustment type is PercentChangeInCapacity. '
ScalingAdjustment:
allOf:
- $ref: '#/components/schemas/PolicyIncrement'
- description: 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.
Cooldown:
allOf:
- $ref: '#/components/schemas/Cooldown'
- description: The duration of the policy's cooldown period, in seconds.
StepAdjustments:
allOf:
- $ref: '#/components/schemas/StepAdjustments'
- description: A set of adjustments that enable you to scale based on the size of the alarm breach.
MetricAggregationType:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen32'
- description: The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.
EstimatedInstanceWarmup:
allOf:
- $ref: '#/components/schemas/EstimatedInstanceWarmup'
- description: The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
Alarms:
allOf:
- $ref: '#/components/schemas/Alarms'
- description: The CloudWatch alarms related to the policy.
TargetTrackingConfiguration:
allOf:
- $ref: '#/components/schemas/TargetTrackingConfiguration'
- description: A target tracking scaling policy.
Enabled:
allOf:
- $ref: '#/components/schemas/ScalingPolicyEnabled'
- description: Indicates whether the policy is enabled (true) or disabled (false).
PredictiveScalingConfiguration:
allOf:
- $ref: '#/components/schemas/PredictiveScalingConfiguration'
- description: A predictive scaling policy.
description: Describes a scaling policy.
PredictiveScalingMode:
type: string
enum:
- ForecastAndScale
- ForecastOnly
ResourceName:
type: string
minLength: 1
maxLength: 1600
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
TargetTrackingMetricDataQueries:
type: array
items:
$ref: '#/components/schemas/TargetTrackingMetricDataQuery'
DescribePoliciesType:
type: object
title: DescribePoliciesType
properties:
AutoScalingGroupName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The name of the Auto Scaling group.
PolicyNames:
allOf:
- $ref: '#/components/schemas/PolicyNames'
- description: 'The names of one or more policies. If you omit this property, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.
Array Members: Maximum number of 50 items.
' PolicyTypes: allOf: - $ref: '#/components/schemas/PolicyTypes' - description: One or more policy types. The valid values areSimpleScaling, StepScaling, TargetTrackingScaling, and PredictiveScaling.
NextToken:
allOf:
- $ref: '#/components/schemas/XmlString'
- description: The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords:
allOf:
- $ref: '#/components/schemas/MaxRecords'
- description: The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.
PredictiveScalingMaxCapacityBreachBehavior:
type: string
enum:
- HonorMaxCapacity
- IncreaseMaxCapacity
MetricStatistic:
type: string
enum:
- Average
- Minimum
- Maximum
- SampleCount
- Sum
CustomizedMetricSpecification:
type: object
properties:
MetricName:
allOf:
- $ref: '#/components/schemas/MetricName'
- description: The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
Namespace:
allOf:
- $ref: '#/components/schemas/MetricNamespace'
- description: The namespace of the metric.
Dimensions:
allOf:
- $ref: '#/components/schemas/MetricDimensions'
- description: 'The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
' Statistic: allOf: - $ref: '#/components/schemas/MetricStatistic' - description: The statistic of the metric. Unit: allOf: - $ref: '#/components/schemas/MetricUnit' - description: The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference. Metrics: allOf: - $ref: '#/components/schemas/TargetTrackingMetricDataQueries' - description: The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions. description:Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.
To create your customized metric specification:
Add values for each required property 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 the CloudWatch terminology below, see Amazon CloudWatch concepts.
Each individual service provides information about the metrics, namespace, and dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is 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 of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
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.
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.
description:Describes a scaling metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.