ScalingPolicy
Describes a scaling policy.
Contents
- AdjustmentType
-
Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are
ChangeInCapacity
,ExactCapacity
, andPercentChangeInCapacity
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- Alarms.member.N
-
The CloudWatch alarms related to the policy.
Type: Array of Alarm objects
Required: No
- AutoScalingGroupName
-
The name of the Auto Scaling group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- Cooldown
-
The duration of the policy's cooldown period, in seconds.
Type: Integer
Required: No
- Enabled
-
Indicates whether the policy is enabled (
true
) or disabled (false
).Type: Boolean
Required: No
- EstimatedInstanceWarmup
-
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
Type: Integer
Required: No
- MetricAggregationType
-
The aggregation type for the CloudWatch metrics. The valid values are
Minimum
,Maximum
, andAverage
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- MinAdjustmentMagnitude
-
The minimum value to scale by when the adjustment type is
PercentChangeInCapacity
.Type: Integer
Required: No
- MinAdjustmentStep
-
This member has been deprecated.
Available for backward compatibility. Use
MinAdjustmentMagnitude
instead.Type: Integer
Required: No
- PolicyARN
-
The Amazon Resource Name (ARN) of the policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- PolicyName
-
The name of the scaling policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- PolicyType
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
-
- PredictiveScalingConfiguration
-
A predictive scaling policy.
Type: PredictiveScalingConfiguration object
Required: No
- ScalingAdjustment
-
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.
Type: Integer
Required: No
- StepAdjustments.member.N
-
A set of adjustments that enable you to scale based on the size of the alarm breach.
Type: Array of StepAdjustment objects
Required: No
- TargetTrackingConfiguration
-
A target tracking scaling policy.
Type: TargetTrackingConfiguration object
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: