Network.AWS.AutoScaling.PutScalingPolicy

Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.

If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.

See: AWS API Reference for PutScalingPolicy.

Creating a Request

putScalingPolicy

Arguments

:: Text

pspAutoScalingGroupName

-> Text

pspPolicyName

-> Text

pspAdjustmentType

-> PutScalingPolicy

Creates a value of PutScalingPolicy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pspEstimatedInstanceWarmup
• pspMinAdjustmentStep
• pspPolicyType
• pspStepAdjustments
• pspScalingAdjustment
• pspCooldown
• pspMetricAggregationType
• pspMinAdjustmentMagnitude
• pspAutoScalingGroupName
• pspPolicyName
• pspAdjustmentType

data PutScalingPolicy

See: putScalingPolicy smart constructor.

Instances

Eq PutScalingPolicy

Data PutScalingPolicy

Read PutScalingPolicy

Show PutScalingPolicy

Generic PutScalingPolicy

AWSRequest PutScalingPolicy

ToPath PutScalingPolicy

ToHeaders PutScalingPolicy

ToQuery PutScalingPolicy

Typeable * PutScalingPolicy

type Rep PutScalingPolicy

type Rs PutScalingPolicy = PutScalingPolicyResponse

Request Lenses

pspEstimatedInstanceWarmup :: Lens' PutScalingPolicy (Maybe Int)

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.

This parameter is not supported if the policy type is SimpleScaling.

pspMinAdjustmentStep :: Lens' PutScalingPolicy (Maybe Int)

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

pspPolicyType :: Lens' PutScalingPolicy (Maybe Text)

The policy type. Valid values are SimpleScaling and StepScaling. If the policy type is null, the value is treated as SimpleScaling.

pspStepAdjustments :: Lens' PutScalingPolicy [StepAdjustment]

A set of adjustments that enable you to scale based on the size of the alarm breach.

This parameter is required if the policy type is StepScaling and not supported otherwise.

pspScalingAdjustment :: Lens' PutScalingPolicy (Maybe Int)

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.

This parameter is required if the policy type is SimpleScaling and not supported otherwise.

pspCooldown :: Lens' PutScalingPolicy (Maybe Int)

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.

This parameter is not supported unless the policy type is SimpleScaling.

For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.

pspMetricAggregationType :: Lens' PutScalingPolicy (Maybe Text)

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

This parameter is not supported if the policy type is SimpleScaling.

pspMinAdjustmentMagnitude :: Lens' PutScalingPolicy (Maybe Int)

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

pspAutoScalingGroupName :: Lens' PutScalingPolicy Text

The name or ARN of the group.

pspPolicyName :: Lens' PutScalingPolicy Text

The name of the policy.

pspAdjustmentType :: Lens' PutScalingPolicy Text

The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.

Destructuring the Response

putScalingPolicyResponse

Arguments

:: Int

psprsStatus

-> PutScalingPolicyResponse

Creates a value of PutScalingPolicyResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• psprsPolicyARN
• psprsStatus

data PutScalingPolicyResponse

See: putScalingPolicyResponse smart constructor.

Instances

Eq PutScalingPolicyResponse

Data PutScalingPolicyResponse

Read PutScalingPolicyResponse

Show PutScalingPolicyResponse

Generic PutScalingPolicyResponse

Typeable * PutScalingPolicyResponse

type Rep PutScalingPolicyResponse

Response Lenses

psprsPolicyARN :: Lens' PutScalingPolicyResponse (Maybe Text)

The Amazon Resource Name (ARN) of the policy.

psprsStatus :: Lens' PutScalingPolicyResponse Int

The response status code.