AWS Auto Scaling
API Reference (API Version 2018-01-06)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

CreateScalingPlan

Creates a scaling plan.

Request Syntax

{ "ApplicationSource": { "CloudFormationStackARN": "string", "TagFilters": [ { "Key": "string", "Values": [ "string" ] } ] }, "ScalingInstructions": [ { "CustomizedLoadMetricSpecification": { "Dimensions": [ { "Name": "string", "Value": "string" } ], "MetricName": "string", "Namespace": "string", "Statistic": "string", "Unit": "string" }, "DisableDynamicScaling": boolean, "MaxCapacity": number, "MinCapacity": number, "PredefinedLoadMetricSpecification": { "PredefinedLoadMetricType": "string", "ResourceLabel": "string" }, "PredictiveScalingMaxCapacityBehavior": "string", "PredictiveScalingMaxCapacityBuffer": number, "PredictiveScalingMode": "string", "ResourceId": "string", "ScalableDimension": "string", "ScalingPolicyUpdateBehavior": "string", "ScheduledActionBufferTime": number, "ServiceNamespace": "string", "TargetTrackingConfigurations": [ { "CustomizedScalingMetricSpecification": { "Dimensions": [ { "Name": "string", "Value": "string" } ], "MetricName": "string", "Namespace": "string", "Statistic": "string", "Unit": "string" }, "DisableScaleIn": boolean, "EstimatedInstanceWarmup": number, "PredefinedScalingMetricSpecification": { "PredefinedScalingMetricType": "string", "ResourceLabel": "string" }, "ScaleInCooldown": number, "ScaleOutCooldown": number, "TargetValue": number } ] } ], "ScalingPlanName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ApplicationSource

A CloudFormation stack or set of tags. You can create one scaling plan per application source.

Type: ApplicationSource object

Required: Yes

ScalingInstructions

The scaling instructions.

Type: Array of ScalingInstruction objects

Required: Yes

ScalingPlanName

The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{Print}&&[^|:/]]+

Required: Yes

Response Syntax

{ "ScalingPlanVersion": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ScalingPlanVersion

The version number of the scaling plan. This value is always 1. Currently, you cannot have multiple scaling plan versions.

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentUpdateException

Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.

HTTP Status Code: 400

InternalServiceException

The service encountered an internal error.

HTTP Status Code: 400

LimitExceededException

Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded.

HTTP Status Code: 400

ValidationException

An exception was thrown for a validation issue. Review the parameters provided.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: