software.amazon.awscdk.services.autoscaling

Class StepScalingPolicy.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.StepScalingPolicy.Builder

Enclosing class:

StepScalingPolicy

public static final class StepScalingPolicy.Builder
extends java.lang.Object

A fluent builder for StepScalingPolicy.

Method Summary

Modifier and Type	Method and Description
StepScalingPolicy.Builder	adjustmentType(AdjustmentType adjustmentType) How the adjustment numbers inside 'intervals' are interpreted.
StepScalingPolicy.Builder	autoScalingGroup(IAutoScalingGroup autoScalingGroup) The auto scaling group.
StepScalingPolicy	build()
StepScalingPolicy.Builder	cooldown(Duration cooldown) Grace period after scaling activity.
static StepScalingPolicy.Builder	create(software.constructs.Construct scope, java.lang.String id)
StepScalingPolicy.Builder	estimatedInstanceWarmup(Duration estimatedInstanceWarmup) Estimated time until a newly launched instance can send metrics to CloudWatch.
StepScalingPolicy.Builder	evaluationPeriods(java.lang.Number evaluationPeriods) How many evaluation periods of the metric to wait before triggering a scaling action.
StepScalingPolicy.Builder	metric(IMetric metric) Metric to scale on.
StepScalingPolicy.Builder	metricAggregationType(MetricAggregationType metricAggregationType) Aggregation to apply to all data points over the evaluation periods.
StepScalingPolicy.Builder	minAdjustmentMagnitude(java.lang.Number minAdjustmentMagnitude) Minimum absolute number to adjust capacity with as result of percentage scaling.
StepScalingPolicy.Builder	scalingSteps(java.util.List<? extends ScalingInterval> scalingSteps) The intervals for scaling.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static StepScalingPolicy.Builder create(software.constructs.Construct scope,
                                               java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of StepScalingPolicy.Builder.

metric

public StepScalingPolicy.Builder metric(IMetric metric)

Metric to scale on.

Parameters:

metric - Metric to scale on. This parameter is required.

Returns:

this

scalingSteps

public StepScalingPolicy.Builder scalingSteps(java.util.List<? extends ScalingInterval> scalingSteps)

The intervals for scaling.

Maps a range of metric values to a particular scaling behavior.

Parameters:

scalingSteps - The intervals for scaling. This parameter is required.

Returns:

this

adjustmentType

public StepScalingPolicy.Builder adjustmentType(AdjustmentType adjustmentType)

How the adjustment numbers inside 'intervals' are interpreted.

Default: ChangeInCapacity

Parameters:

adjustmentType - How the adjustment numbers inside 'intervals' are interpreted. This parameter is required.

Returns:

this

cooldown

public StepScalingPolicy.Builder cooldown(Duration cooldown)

Grace period after scaling activity.

Default: Default cooldown period on your AutoScalingGroup

Parameters:

cooldown - Grace period after scaling activity. This parameter is required.

Returns:

this

estimatedInstanceWarmup

public StepScalingPolicy.Builder estimatedInstanceWarmup(Duration estimatedInstanceWarmup)

Estimated time until a newly launched instance can send metrics to CloudWatch.

Default: Same as the cooldown

Parameters:

estimatedInstanceWarmup - Estimated time until a newly launched instance can send metrics to CloudWatch. This parameter is required.

Returns:

this

evaluationPeriods

public StepScalingPolicy.Builder evaluationPeriods(java.lang.Number evaluationPeriods)

How many evaluation periods of the metric to wait before triggering a scaling action.

Raising this value can be used to smooth out the metric, at the expense of slower response times.

Default: 1

Parameters:

evaluationPeriods - How many evaluation periods of the metric to wait before triggering a scaling action. This parameter is required.

Returns:

this

metricAggregationType

public StepScalingPolicy.Builder metricAggregationType(MetricAggregationType metricAggregationType)

Aggregation to apply to all data points over the evaluation periods.

Only has meaning if evaluationPeriods != 1.

Default: - The statistic from the metric if applicable (MIN, MAX, AVERAGE), otherwise AVERAGE.

Parameters:

metricAggregationType - Aggregation to apply to all data points over the evaluation periods. This parameter is required.

Returns:

this

minAdjustmentMagnitude

public StepScalingPolicy.Builder minAdjustmentMagnitude(java.lang.Number minAdjustmentMagnitude)

Minimum absolute number to adjust capacity with as result of percentage scaling.

Only when using AdjustmentType = PercentChangeInCapacity, this number controls the minimum absolute effect size.

Default: No minimum scaling effect

Parameters:

minAdjustmentMagnitude - Minimum absolute number to adjust capacity with as result of percentage scaling. This parameter is required.

Returns:

this

autoScalingGroup

public StepScalingPolicy.Builder autoScalingGroup(IAutoScalingGroup autoScalingGroup)

The auto scaling group.

Parameters:

autoScalingGroup - The auto scaling group. This parameter is required.

Returns:

this

build

public StepScalingPolicy build()