software.amazon.awscdk.services.applicationautoscaling

Class BasicStepScalingPolicyProps.Builder

java.lang.Object

software.amazon.awscdk.services.applicationautoscaling.BasicStepScalingPolicyProps.Builder

Enclosing interface:

BasicStepScalingPolicyProps

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

A builder for BasicStepScalingPolicyProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
BasicStepScalingPolicyProps.Builder	adjustmentType(AdjustmentType adjustmentType) Sets the value of BasicStepScalingPolicyProps.getAdjustmentType()
BasicStepScalingPolicyProps	build() Builds the configured instance.
BasicStepScalingPolicyProps.Builder	cooldown(Duration cooldown) Sets the value of BasicStepScalingPolicyProps.getCooldown()
BasicStepScalingPolicyProps.Builder	datapointsToAlarm(java.lang.Number datapointsToAlarm) Sets the value of BasicStepScalingPolicyProps.getDatapointsToAlarm()
BasicStepScalingPolicyProps.Builder	evaluationPeriods(java.lang.Number evaluationPeriods) Sets the value of BasicStepScalingPolicyProps.getEvaluationPeriods()
BasicStepScalingPolicyProps.Builder	metric(IMetric metric) Sets the value of BasicStepScalingPolicyProps.getMetric()
BasicStepScalingPolicyProps.Builder	metricAggregationType(MetricAggregationType metricAggregationType) Sets the value of BasicStepScalingPolicyProps.getMetricAggregationType()
BasicStepScalingPolicyProps.Builder	minAdjustmentMagnitude(java.lang.Number minAdjustmentMagnitude) Sets the value of BasicStepScalingPolicyProps.getMinAdjustmentMagnitude()
BasicStepScalingPolicyProps.Builder	scalingSteps(java.util.List<? extends ScalingInterval> scalingSteps) Sets the value of BasicStepScalingPolicyProps.getScalingSteps()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

metric

public BasicStepScalingPolicyProps.Builder metric(IMetric metric)

Sets the value of BasicStepScalingPolicyProps.getMetric()

Parameters:

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

Returns:

this

scalingSteps

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

Sets the value of BasicStepScalingPolicyProps.getScalingSteps()

Parameters:

scalingSteps - The intervals for scaling. This parameter is required. Maps a range of metric values to a particular scaling behavior.

Returns:

this

adjustmentType

public BasicStepScalingPolicyProps.Builder adjustmentType(AdjustmentType adjustmentType)

Sets the value of BasicStepScalingPolicyProps.getAdjustmentType()

Parameters:

adjustmentType - How the adjustment numbers inside 'intervals' are interpreted.

Returns:

this

cooldown

public BasicStepScalingPolicyProps.Builder cooldown(Duration cooldown)

Sets the value of BasicStepScalingPolicyProps.getCooldown()

Parameters:

cooldown - 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.

Returns:

this

datapointsToAlarm

public BasicStepScalingPolicyProps.Builder datapointsToAlarm(java.lang.Number datapointsToAlarm)

Sets the value of BasicStepScalingPolicyProps.getDatapointsToAlarm()

Parameters:

datapointsToAlarm - The number of data points out of the evaluation periods that must be breaching to trigger a scaling action. Creates an "M out of N" alarm, where this property is the M and the value set for evaluationPeriods is the N value.

Only has meaning if evaluationPeriods != 1.

Returns:

this

evaluationPeriods

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

Sets the value of BasicStepScalingPolicyProps.getEvaluationPeriods()

Parameters:

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.

If datapointsToAlarm is not set, then all data points in the evaluation period must meet the criteria to trigger a scaling action.

Returns:

this

metricAggregationType

public BasicStepScalingPolicyProps.Builder metricAggregationType(MetricAggregationType metricAggregationType)

Sets the value of BasicStepScalingPolicyProps.getMetricAggregationType()

Parameters:

metricAggregationType - Aggregation to apply to all data points over the evaluation periods. Only has meaning if evaluationPeriods != 1.

Returns:

this

minAdjustmentMagnitude

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

Sets the value of BasicStepScalingPolicyProps.getMinAdjustmentMagnitude()

Parameters:

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.

Returns:

this

build

public BasicStepScalingPolicyProps build()

Builds the configured instance.

Returns:

a new instance of BasicStepScalingPolicyProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided