Documentation

Describes a scaling policy.

See: newScalingPolicy smart constructor.

Create a value of ScalingPolicy 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:

$sel:minAdjustmentStep:ScalingPolicy', scalingPolicy_minAdjustmentStep - Available for backward compatibility. Use MinAdjustmentMagnitude instead.

$sel:estimatedInstanceWarmup:ScalingPolicy', scalingPolicy_estimatedInstanceWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

$sel:policyName:ScalingPolicy', scalingPolicy_policyName - The name of the scaling policy.

$sel:enabled:ScalingPolicy', scalingPolicy_enabled - Indicates whether the policy is enabled (true) or disabled (false).

$sel:policyType:ScalingPolicy', scalingPolicy_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.

$sel:stepAdjustments:ScalingPolicy', scalingPolicy_stepAdjustments - A set of adjustments that enable you to scale based on the size of the alarm breach.

$sel:targetTrackingConfiguration:ScalingPolicy', scalingPolicy_targetTrackingConfiguration - A target tracking scaling policy.

$sel:adjustmentType:ScalingPolicy', scalingPolicy_adjustmentType - Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

$sel:autoScalingGroupName:ScalingPolicy', scalingPolicy_autoScalingGroupName - The name of the Auto Scaling group.

$sel:predictiveScalingConfiguration:ScalingPolicy', scalingPolicy_predictiveScalingConfiguration - A predictive scaling policy.

$sel:scalingAdjustment:ScalingPolicy', scalingPolicy_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.

$sel:cooldown:ScalingPolicy', scalingPolicy_cooldown - The duration of the policy's cooldown period, in seconds.

$sel:policyARN:ScalingPolicy', scalingPolicy_policyARN - The Amazon Resource Name (ARN) of the policy.

$sel:alarms:ScalingPolicy', scalingPolicy_alarms - The CloudWatch alarms related to the policy.

$sel:metricAggregationType:ScalingPolicy', scalingPolicy_metricAggregationType - The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

$sel:minAdjustmentMagnitude:ScalingPolicy', scalingPolicy_minAdjustmentMagnitude - The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

The name of the scaling policy.

Indicates whether the policy is enabled (true) or disabled (false).

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.

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

A target tracking scaling policy.

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

The name of the Auto Scaling group.

A predictive scaling policy.

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 duration of the policy's cooldown period, in seconds.

The Amazon Resource Name (ARN) of the policy.

The CloudWatch alarms related to the policy.

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

The minimum value to scale by when the adjustment type is PercentChangeInCapacity.