openapi: 3.0.0 info: version: 2011-01-01 x-release: v4 title: 'Auto Scaling #Action=AttachInstances #Action=AttachInstances #Action=PutScalingPolicy API' description: Amazon EC2 Auto Scaling

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=PutScalingPolicy' paths: /#Action=PutScalingPolicy: 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: PutScalingPolicy operationId: GET_PutScalingPolicy 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 DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.

responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/PolicyARNType' examples: GET_PutScalingPolicy200Example: summary: Default GET_PutScalingPolicy 200 response x-microcks-default: true value: PolicyARN: arn:aws:service:us-east-1:123456789012:resource/example Alarms: example-string '480': description: LimitExceededFault content: text/xml: schema: $ref: '#/components/schemas/LimitExceededFault' examples: GET_PutScalingPolicy480Example: summary: Default GET_PutScalingPolicy 480 response x-microcks-default: true value: {} '481': description: ResourceContentionFault content: text/xml: schema: $ref: '#/components/schemas/ResourceContentionFault' examples: GET_PutScalingPolicy481Example: summary: Default GET_PutScalingPolicy 481 response x-microcks-default: true value: {} '482': description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: '#/components/schemas/ServiceLinkedRoleFailure' parameters: - name: AutoScalingGroupName in: query required: true 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: PolicyName in: query required: true description: The name of the policy. schema: type: string minLength: 1 maxLength: 255 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' - name: PolicyType in: query required: false description: '

One of the following policy types:

' schema: type: string minLength: 1 maxLength: 64 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' - name: AdjustmentType in: query required: false description:

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.

schema: type: string minLength: 1 maxLength: 255 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' - name: MinAdjustmentStep in: query required: false description: Available for backward compatibility. Use MinAdjustmentMagnitude instead. schema: type: integer deprecated: true - name: MinAdjustmentMagnitude in: query required: false description:

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.

 schema: type: integer - name: ScalingAdjustment in: query required: false 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. For exact capacity, you must specify a positive value.

Required if the policy type is SimpleScaling. (Not used with any other policy type.)

schema: type: integer - name: Cooldown in: query required: false description: '

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

' schema: type: integer - name: MetricAggregationType in: query required: false description:

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.

schema: type: string minLength: 1 maxLength: 32 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' - name: StepAdjustments in: query required: false description:

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

schema: type: array items: $ref: '#/components/schemas/StepAdjustment' - name: EstimatedInstanceWarmup in: query required: false description:

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.

 schema: type: integer - name: TargetTrackingConfiguration in: query required: false description:

A target tracking scaling policy. Provides support for predefined or custom metrics.

The following predefined metrics are available:

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.

schema: 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.

DisableScaleIn: allOf: - $ref: '#/components/schemas/DisableScaleIn' - description: Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false. description: Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling. - name: Enabled in: query required: false description: Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. schema: type: boolean - name: PredictiveScalingConfiguration in: query required: false description:

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.

schema: 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 to ForecastOnly 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:

MaxCapacityBuffer: allOf: - $ref: '#/components/schemas/PredictiveScalingMaxCapacityBuffer' - description:

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.

description: Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling. - name: Action in: query required: true schema: type: string enum: - PutScalingPolicy - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Put Scaling Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#Action=PutScalingPolicy' post: x-aws-operation-name: PutScalingPolicy operationId: POST_PutScalingPolicy 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 DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.

responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/PolicyARNType' examples: POST_PutScalingPolicy200Example: summary: Default POST_PutScalingPolicy 200 response x-microcks-default: true value: PolicyARN: arn:aws:service:us-east-1:123456789012:resource/example Alarms: example-string '480': description: LimitExceededFault content: text/xml: schema: $ref: '#/components/schemas/LimitExceededFault' examples: POST_PutScalingPolicy480Example: summary: Default POST_PutScalingPolicy 480 response x-microcks-default: true value: {} '481': description: ResourceContentionFault content: text/xml: schema: $ref: '#/components/schemas/ResourceContentionFault' examples: POST_PutScalingPolicy481Example: summary: Default POST_PutScalingPolicy 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/PutScalingPolicyType' parameters: - name: Action in: query required: true schema: type: string enum: - PutScalingPolicy - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Put Scaling Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#Action=PutScalingPolicy' components: parameters: X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false schemas: 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.

Unit: allOf: - $ref: '#/components/schemas/MetricUnit' - description: The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference. description:

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.

DisableScaleIn: allOf: - $ref: '#/components/schemas/DisableScaleIn' - description: Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false. description: Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling. MetricDataQueries: type: array items: $ref: '#/components/schemas/MetricDataQuery' PolicyIncrement: type: integer MetricName: type: string PredefinedScalingMetricType: type: string enum: - ASGAverageCPUUtilization - ASGAverageNetworkIn - ASGAverageNetworkOut - ALBRequestCountPerTarget PredictiveScalingMaxCapacityBuffer: type: integer minimum: 0 maximum: 100 MetricDimensions: type: array items: $ref: '#/components/schemas/MetricDimension' PredefinedMetricSpecification: type: object required: - PredefinedMetricType properties: PredefinedMetricType: allOf: - $ref: '#/components/schemas/MetricType' - description:

The metric type. The following predefined metrics are available:

ResourceLabel: allOf: - $ref: '#/components/schemas/XmlStringMaxLen1023' - description:

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:

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: {} EstimatedInstanceWarmup: type: integer XmlStringMaxLen64: type: string minLength: 1 maxLength: 64 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' 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 is ASGCPUUtilization, 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:

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. ' XmlStringMetricStat: type: string minLength: 1 maxLength: 100 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' XmlStringMaxLen32: type: string minLength: 1 maxLength: 32 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' StepAdjustments: type: array items: $ref: '#/components/schemas/StepAdjustment' 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. 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. 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:

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.

PredictiveScalingCustomizedLoadMetric: 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 load metric. Use multiple metric data queries only if you are performing a math expression on returned data. ' description: Describes a custom load metric for a predictive scaling policy. Alarms: type: array items: $ref: '#/components/schemas/Alarm' StepAdjustment: type: object required: - ScalingAdjustment properties: MetricIntervalLowerBound: allOf: - $ref: '#/components/schemas/MetricScale' - description: The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. MetricIntervalUpperBound: allOf: - $ref: '#/components/schemas/MetricScale' - description:

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.

description:

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:

There are a few rules for the step adjustments for your step policy:

For more information, see Step adjustments in the Amazon EC2 Auto Scaling User Guide.

MetricUnit: type: string PolicyARNType: type: object example: Alarms: - AlarmARN: arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e AlarmName: TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e - AlarmARN: arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2 AlarmName: TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2 PolicyARN: arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:228f02c2-c665-4bfd-aaac-8b04080bea3c:autoScalingGroupName/my-auto-scaling-group:policyName/alb1000-target-tracking-scaling-policy properties: PolicyARN: allOf: - $ref: '#/components/schemas/ResourceName' - description: The Amazon Resource Name (ARN) of the policy. Alarms: allOf: - $ref: '#/components/schemas/Alarms' - description: The CloudWatch alarms created for the target tracking scaling policy. description: Contains the output of PutScalingPolicy. 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.

Unit: allOf: - $ref: '#/components/schemas/MetricUnit' - description: The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference. description:

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.

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. 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 all TargetTrackingMetricDataQuery 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.

' MetricStat: allOf: - $ref: '#/components/schemas/TargetTrackingMetricStat' - description: '

Information about the metric data to return.

Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.

' Label: allOf: - $ref: '#/components/schemas/XmlStringMetricLabel' - description: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents. ReturnData: allOf: - $ref: '#/components/schemas/ReturnData' - description:

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

description: 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. ReturnData: type: boolean XmlStringMaxLen255: type: string minLength: 1 maxLength: 255 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' ServiceLinkedRoleFailure: {} 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.

PredefinedMetricPairSpecification: allOf: - $ref: '#/components/schemas/PredictiveScalingPredefinedMetricPair' - description: The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use. PredefinedScalingMetricSpecification: allOf: - $ref: '#/components/schemas/PredictiveScalingPredefinedScalingMetric' - description: The predefined scaling metric specification. PredefinedLoadMetricSpecification: allOf: - $ref: '#/components/schemas/PredictiveScalingPredefinedLoadMetric' - description: The predefined load metric specification. CustomizedScalingMetricSpecification: allOf: - $ref: '#/components/schemas/PredictiveScalingCustomizedScalingMetric' - description: The customized scaling metric specification. CustomizedLoadMetricSpecification: allOf: - $ref: '#/components/schemas/PredictiveScalingCustomizedLoadMetric' - description: The customized load metric specification. CustomizedCapacityMetricSpecification: allOf: - $ref: '#/components/schemas/PredictiveScalingCustomizedCapacityMetric' - description: The customized capacity metric specification. description:

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

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 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 all MetricDataQuery 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.

' MetricStat: allOf: - $ref: '#/components/schemas/MetricStat' - description: '

Information about the metric data to return.

Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.

' Label: allOf: - $ref: '#/components/schemas/XmlStringMetricLabel' - description: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents. ReturnData: allOf: - $ref: '#/components/schemas/ReturnData' - description:

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

description:

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 PutScalingPolicyType: type: object required: - AutoScalingGroupName - PolicyName title: PutScalingPolicyType properties: AutoScalingGroupName: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: The name of the Auto Scaling group. PolicyName: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: The name of the policy. PolicyType: allOf: - $ref: '#/components/schemas/XmlStringMaxLen64' - description: '

One of the following policy types:

' 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 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: 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. 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: 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. For exact capacity, you must specify a positive value.

Required if the policy type is SimpleScaling. (Not used with any other policy type.)

Cooldown: allOf: - $ref: '#/components/schemas/Cooldown' - description: '

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: allOf: - $ref: '#/components/schemas/XmlStringMaxLen32' - description:

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: allOf: - $ref: '#/components/schemas/StepAdjustments' - description:

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: allOf: - $ref: '#/components/schemas/EstimatedInstanceWarmup' - description:

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: allOf: - $ref: '#/components/schemas/TargetTrackingConfiguration' - description:

A target tracking scaling policy. Provides support for predefined or custom metrics.

The following predefined metrics are available:

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: allOf: - $ref: '#/components/schemas/ScalingPolicyEnabled' - description: Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. PredictiveScalingConfiguration: allOf: - $ref: '#/components/schemas/PredictiveScalingConfiguration' - description:

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.

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 to ForecastOnly 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:

MaxCapacityBuffer: allOf: - $ref: '#/components/schemas/PredictiveScalingMaxCapacityBuffer' - description:

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.

description: Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling. PredictiveScalingMode: type: string enum: - ForecastAndScale - ForecastOnly LimitExceededFault: {} 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' 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:

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.

 PredictiveScalingPredefinedScalingMetric: type: object required: - PredefinedMetricType properties: PredefinedMetricType: allOf: - $ref: '#/components/schemas/PredefinedScalingMetricType' - 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 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:

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.

securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/autoscaling/ x-hasEquivalentPaths: true