Package software.amazon.awscdk.services.autoscaling

Class BasicStepScalingPolicyProps.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.BasicStepScalingPolicyProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BasicStepScalingPolicyProps>

Enclosing interface:

BasicStepScalingPolicyProps

@Stability(Stable)
public static final class BasicStepScalingPolicyProps.Builder
extends Object
implements software.amazon.jsii.Builder<BasicStepScalingPolicyProps>

A builder for BasicStepScalingPolicyProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	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(Number datapointsToAlarm)	Sets the value of BasicStepScalingPolicyProps.getDatapointsToAlarm()
BasicStepScalingPolicyProps.Builder	estimatedInstanceWarmup(Duration estimatedInstanceWarmup)	Sets the value of BasicStepScalingPolicyProps.getEstimatedInstanceWarmup()
BasicStepScalingPolicyProps.Builder	evaluationPeriods(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(Number minAdjustmentMagnitude)	Sets the value of BasicStepScalingPolicyProps.getMinAdjustmentMagnitude()
BasicStepScalingPolicyProps.Builder	scalingSteps(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 Details

Builder

public Builder()

Method Details

metric

@Stability(Stable)
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

@Stability(Stable)
public BasicStepScalingPolicyProps.Builder scalingSteps(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.

Must be between 2 and 40 steps.

Returns:

this

adjustmentType

@Stability(Stable)
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

@Stability(Stable)
public BasicStepScalingPolicyProps.Builder cooldown(Duration cooldown)

Sets the value of BasicStepScalingPolicyProps.getCooldown()

Parameters:

cooldown - Grace period after scaling activity.

Returns:

this

datapointsToAlarm

@Stability(Stable)
public BasicStepScalingPolicyProps.Builder datapointsToAlarm(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. Must be less than or equal to evaluationPeriods.

Returns:

this

estimatedInstanceWarmup

@Stability(Stable)
public BasicStepScalingPolicyProps.Builder estimatedInstanceWarmup(Duration estimatedInstanceWarmup)

Sets the value of BasicStepScalingPolicyProps.getEstimatedInstanceWarmup()

Parameters:

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

Returns:

this

evaluationPeriods

@Stability(Stable)
public BasicStepScalingPolicyProps.Builder evaluationPeriods(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

@Stability(Stable)
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

@Stability(Stable)
public BasicStepScalingPolicyProps.Builder minAdjustmentMagnitude(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

@Stability(Stable)
public BasicStepScalingPolicyProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of BasicStepScalingPolicyProps

Throws:

NullPointerException - if any required attribute was not provided