Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data PutScalingPolicy = PutScalingPolicy' {
- adjustmentType :: Maybe Text
- cooldown :: Maybe Int
- enabled :: Maybe Bool
- estimatedInstanceWarmup :: Maybe Int
- metricAggregationType :: Maybe Text
- minAdjustmentMagnitude :: Maybe Int
- minAdjustmentStep :: Maybe Int
- policyType :: Maybe Text
- predictiveScalingConfiguration :: Maybe PredictiveScalingConfiguration
- scalingAdjustment :: Maybe Int
- stepAdjustments :: Maybe [StepAdjustment]
- targetTrackingConfiguration :: Maybe TargetTrackingConfiguration
- autoScalingGroupName :: Text
- policyName :: Text
- newPutScalingPolicy :: Text -> Text -> PutScalingPolicy
- putScalingPolicy_adjustmentType :: Lens' PutScalingPolicy (Maybe Text)
- putScalingPolicy_cooldown :: Lens' PutScalingPolicy (Maybe Int)
- putScalingPolicy_enabled :: Lens' PutScalingPolicy (Maybe Bool)
- putScalingPolicy_estimatedInstanceWarmup :: Lens' PutScalingPolicy (Maybe Int)
- putScalingPolicy_metricAggregationType :: Lens' PutScalingPolicy (Maybe Text)
- putScalingPolicy_minAdjustmentMagnitude :: Lens' PutScalingPolicy (Maybe Int)
- putScalingPolicy_minAdjustmentStep :: Lens' PutScalingPolicy (Maybe Int)
- putScalingPolicy_policyType :: Lens' PutScalingPolicy (Maybe Text)
- putScalingPolicy_predictiveScalingConfiguration :: Lens' PutScalingPolicy (Maybe PredictiveScalingConfiguration)
- putScalingPolicy_scalingAdjustment :: Lens' PutScalingPolicy (Maybe Int)
- putScalingPolicy_stepAdjustments :: Lens' PutScalingPolicy (Maybe [StepAdjustment])
- putScalingPolicy_targetTrackingConfiguration :: Lens' PutScalingPolicy (Maybe TargetTrackingConfiguration)
- putScalingPolicy_autoScalingGroupName :: Lens' PutScalingPolicy Text
- putScalingPolicy_policyName :: Lens' PutScalingPolicy Text
- data PutScalingPolicyResponse = PutScalingPolicyResponse' {}
- newPutScalingPolicyResponse :: Int -> PutScalingPolicyResponse
- putScalingPolicyResponse_alarms :: Lens' PutScalingPolicyResponse (Maybe [Alarm])
- putScalingPolicyResponse_policyARN :: Lens' PutScalingPolicyResponse (Maybe Text)
- putScalingPolicyResponse_httpStatus :: Lens' PutScalingPolicyResponse Int
Creating a Request
data PutScalingPolicy Source #
See: newPutScalingPolicy
smart constructor.
PutScalingPolicy' | |
|
Instances
Create a value of PutScalingPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutScalingPolicy
, putScalingPolicy_adjustmentType
- 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.
PutScalingPolicy
, putScalingPolicy_cooldown
- 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
PutScalingPolicy
, putScalingPolicy_enabled
- 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.
PutScalingPolicy
, putScalingPolicy_estimatedInstanceWarmup
- 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.
PutScalingPolicy
, putScalingPolicy_metricAggregationType
- 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
.
PutScalingPolicy
, putScalingPolicy_minAdjustmentMagnitude
- 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.
PutScalingPolicy
, putScalingPolicy_minAdjustmentStep
- Available for backward compatibility. Use MinAdjustmentMagnitude
instead.
PutScalingPolicy
, putScalingPolicy_policyType
- One of the following policy types:
TargetTrackingScaling
StepScaling
SimpleScaling
(default)PredictiveScaling
PutScalingPolicy
, putScalingPolicy_predictiveScalingConfiguration
- 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
.
PutScalingPolicy
, putScalingPolicy_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. For exact capacity, you must specify
a positive value.
Required if the policy type is SimpleScaling
. (Not used with any other
policy type.)
PutScalingPolicy
, putScalingPolicy_stepAdjustments
- 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.)
PutScalingPolicy
, putScalingPolicy_targetTrackingConfiguration
- A target tracking scaling policy. Provides support for predefined or
custom metrics.
The following predefined metrics are available:
ASGAverageCPUUtilization
ASGAverageNetworkIn
ASGAverageNetworkOut
ALBRequestCountPerTarget
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
.
PutScalingPolicy
, putScalingPolicy_autoScalingGroupName
- The name of the Auto Scaling group.
PutScalingPolicy
, putScalingPolicy_policyName
- The name of the policy.
Request Lenses
putScalingPolicy_adjustmentType :: Lens' PutScalingPolicy (Maybe Text) Source #
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.
putScalingPolicy_cooldown :: Lens' PutScalingPolicy (Maybe Int) Source #
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
putScalingPolicy_enabled :: Lens' PutScalingPolicy (Maybe Bool) Source #
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.
putScalingPolicy_estimatedInstanceWarmup :: Lens' PutScalingPolicy (Maybe Int) Source #
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.
putScalingPolicy_metricAggregationType :: Lens' PutScalingPolicy (Maybe Text) Source #
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
.
putScalingPolicy_minAdjustmentMagnitude :: Lens' PutScalingPolicy (Maybe Int) Source #
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.
putScalingPolicy_minAdjustmentStep :: Lens' PutScalingPolicy (Maybe Int) Source #
Available for backward compatibility. Use MinAdjustmentMagnitude
instead.
putScalingPolicy_policyType :: Lens' PutScalingPolicy (Maybe Text) Source #
One of the following policy types:
TargetTrackingScaling
StepScaling
SimpleScaling
(default)PredictiveScaling
putScalingPolicy_predictiveScalingConfiguration :: Lens' PutScalingPolicy (Maybe PredictiveScalingConfiguration) Source #
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
.
putScalingPolicy_scalingAdjustment :: Lens' PutScalingPolicy (Maybe Int) Source #
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.)
putScalingPolicy_stepAdjustments :: Lens' PutScalingPolicy (Maybe [StepAdjustment]) Source #
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.)
putScalingPolicy_targetTrackingConfiguration :: Lens' PutScalingPolicy (Maybe TargetTrackingConfiguration) Source #
A target tracking scaling policy. Provides support for predefined or custom metrics.
The following predefined metrics are available:
ASGAverageCPUUtilization
ASGAverageNetworkIn
ASGAverageNetworkOut
ALBRequestCountPerTarget
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
.
putScalingPolicy_autoScalingGroupName :: Lens' PutScalingPolicy Text Source #
The name of the Auto Scaling group.
putScalingPolicy_policyName :: Lens' PutScalingPolicy Text Source #
The name of the policy.
Destructuring the Response
data PutScalingPolicyResponse Source #
Contains the output of PutScalingPolicy.
See: newPutScalingPolicyResponse
smart constructor.
Instances
newPutScalingPolicyResponse Source #
Create a value of PutScalingPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutScalingPolicyResponse
, putScalingPolicyResponse_alarms
- The CloudWatch alarms created for the target tracking scaling policy.
PutScalingPolicyResponse
, putScalingPolicyResponse_policyARN
- The Amazon Resource Name (ARN) of the policy.
$sel:httpStatus:PutScalingPolicyResponse'
, putScalingPolicyResponse_httpStatus
- The response's http status code.
Response Lenses
putScalingPolicyResponse_alarms :: Lens' PutScalingPolicyResponse (Maybe [Alarm]) Source #
The CloudWatch alarms created for the target tracking scaling policy.
putScalingPolicyResponse_policyARN :: Lens' PutScalingPolicyResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the policy.
putScalingPolicyResponse_httpStatus :: Lens' PutScalingPolicyResponse Int Source #
The response's http status code.