software.amazon.awscdk.services.autoscaling

Class StepScalingPolicyProps.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.StepScalingPolicyProps.Builder

Enclosing interface:

StepScalingPolicyProps

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

A builder for StepScalingPolicyProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
StepScalingPolicyProps.Builder	adjustmentType(AdjustmentType adjustmentType) Sets the value of BasicStepScalingPolicyProps.getAdjustmentType()
StepScalingPolicyProps.Builder	autoScalingGroup(IAutoScalingGroup autoScalingGroup) Sets the value of StepScalingPolicyProps.getAutoScalingGroup()
StepScalingPolicyProps	build() Builds the configured instance.
StepScalingPolicyProps.Builder	cooldown(Duration cooldown) Sets the value of BasicStepScalingPolicyProps.getCooldown()
StepScalingPolicyProps.Builder	estimatedInstanceWarmup(Duration estimatedInstanceWarmup) Sets the value of BasicStepScalingPolicyProps.getEstimatedInstanceWarmup()
StepScalingPolicyProps.Builder	evaluationPeriods(java.lang.Number evaluationPeriods) Sets the value of BasicStepScalingPolicyProps.getEvaluationPeriods()
StepScalingPolicyProps.Builder	metric(IMetric metric) Sets the value of BasicStepScalingPolicyProps.getMetric()
StepScalingPolicyProps.Builder	metricAggregationType(MetricAggregationType metricAggregationType) Sets the value of BasicStepScalingPolicyProps.getMetricAggregationType()
StepScalingPolicyProps.Builder	minAdjustmentMagnitude(java.lang.Number minAdjustmentMagnitude) Sets the value of BasicStepScalingPolicyProps.getMinAdjustmentMagnitude()
StepScalingPolicyProps.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

autoScalingGroup

public StepScalingPolicyProps.Builder autoScalingGroup(IAutoScalingGroup autoScalingGroup)

Sets the value of StepScalingPolicyProps.getAutoScalingGroup()

Parameters:

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

Returns:

this

metric

public StepScalingPolicyProps.Builder metric(IMetric metric)

Sets the value of BasicStepScalingPolicyProps.getMetric()

Parameters:

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

Returns:

this

scalingSteps

public StepScalingPolicyProps.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 StepScalingPolicyProps.Builder adjustmentType(AdjustmentType adjustmentType)

Sets the value of BasicStepScalingPolicyProps.getAdjustmentType()

Parameters:

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

Returns:

this

cooldown

public StepScalingPolicyProps.Builder cooldown(Duration cooldown)

Sets the value of BasicStepScalingPolicyProps.getCooldown()

Parameters:

cooldown - Grace period after scaling activity.

Returns:

this

estimatedInstanceWarmup

public StepScalingPolicyProps.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

public StepScalingPolicyProps.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.

Returns:

this

metricAggregationType

public StepScalingPolicyProps.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 StepScalingPolicyProps.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 StepScalingPolicyProps build()

Builds the configured instance.

Returns:

a new instance of StepScalingPolicyProps

Throws:

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