software.amazon.awscdk.services.applicationautoscaling

Class StepScalingPolicy.Builder

java.lang.Object

software.amazon.awscdk.services.applicationautoscaling.StepScalingPolicy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StepScalingPolicy>

Enclosing class:

StepScalingPolicy

@Stability(value=Experimental)
public static final class StepScalingPolicy.Builder
extends Object
implements software.amazon.jsii.Builder<StepScalingPolicy>

(experimental) A fluent builder for StepScalingPolicy.

Method Summary

Modifier and Type	Method and Description
StepScalingPolicy.Builder	adjustmentType(AdjustmentType adjustmentType) (experimental) How the adjustment numbers inside 'intervals' are interpreted.
StepScalingPolicy	build()
StepScalingPolicy.Builder	cooldown(Duration cooldown) (experimental) Grace period after scaling activity.
static StepScalingPolicy.Builder	create(software.constructs.Construct scope, String id)
StepScalingPolicy.Builder	evaluationPeriods(Number evaluationPeriods) (experimental) How many evaluation periods of the metric to wait before triggering a scaling action.
StepScalingPolicy.Builder	metric(IMetric metric) (experimental) Metric to scale on.
StepScalingPolicy.Builder	metricAggregationType(MetricAggregationType metricAggregationType) (experimental) Aggregation to apply to all data points over the evaluation periods.
StepScalingPolicy.Builder	minAdjustmentMagnitude(Number minAdjustmentMagnitude) (experimental) Minimum absolute number to adjust capacity with as result of percentage scaling.
StepScalingPolicy.Builder	scalingSteps(List<? extends ScalingInterval> scalingSteps) (experimental) The intervals for scaling.
StepScalingPolicy.Builder	scalingTarget(IScalableTarget scalingTarget) (experimental) The scaling target.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static StepScalingPolicy.Builder create(software.constructs.Construct scope,
                                                                              String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of StepScalingPolicy.Builder.

metric

@Stability(value=Experimental)
public StepScalingPolicy.Builder metric(IMetric metric)

(experimental) Metric to scale on.

Parameters:

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

Returns:

this

scalingSteps

@Stability(value=Experimental)
public StepScalingPolicy.Builder scalingSteps(List<? extends ScalingInterval> scalingSteps)

(experimental) 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

@Stability(value=Experimental)
public StepScalingPolicy.Builder adjustmentType(AdjustmentType adjustmentType)

(experimental) 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

@Stability(value=Experimental)
public StepScalingPolicy.Builder cooldown(Duration cooldown)

(experimental) Grace period after scaling activity.

Subsequent scale outs during the cooldown period are squashed so that only the biggest scale out happens.

Subsequent scale ins during the cooldown period are ignored.

Default: No cooldown period

Parameters:

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

Returns:

this

See Also:

https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html

evaluationPeriods

@Stability(value=Experimental)
public StepScalingPolicy.Builder evaluationPeriods(Number evaluationPeriods)

(experimental) 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

@Stability(value=Experimental)
public StepScalingPolicy.Builder metricAggregationType(MetricAggregationType metricAggregationType)

(experimental) 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

@Stability(value=Experimental)
public StepScalingPolicy.Builder minAdjustmentMagnitude(Number minAdjustmentMagnitude)

(experimental) 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

scalingTarget

@Stability(value=Experimental)
public StepScalingPolicy.Builder scalingTarget(IScalableTarget scalingTarget)

(experimental) The scaling target.

Parameters:

scalingTarget - The scaling target. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public StepScalingPolicy build()

Specified by:

build in interface software.amazon.jsii.Builder<StepScalingPolicy>