software.amazon.awscdk.services.autoscaling

Class StepScalingAction.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.StepScalingAction.Builder

Enclosing class:

StepScalingAction

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

A fluent builder for StepScalingAction.

Method Summary

Modifier and Type	Method and Description
StepScalingAction.Builder	adjustmentType(AdjustmentType adjustmentType) How the adjustment numbers are interpreted.
StepScalingAction.Builder	autoScalingGroup(IAutoScalingGroup autoScalingGroup) The auto scaling group.
StepScalingAction	build()
StepScalingAction.Builder	cooldown(Duration cooldown) Period after a scaling completes before another scaling activity can start.
static StepScalingAction.Builder	create(software.constructs.Construct scope, java.lang.String id)
StepScalingAction.Builder	estimatedInstanceWarmup(Duration estimatedInstanceWarmup) Estimated time until a newly launched instance can send metrics to CloudWatch.
StepScalingAction.Builder	metricAggregationType(MetricAggregationType metricAggregationType) The aggregation type for the CloudWatch metrics.
StepScalingAction.Builder	minAdjustmentMagnitude(java.lang.Number minAdjustmentMagnitude) Minimum absolute number to adjust capacity with as result of percentage scaling.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static StepScalingAction.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 StepScalingAction.Builder.

autoScalingGroup

public StepScalingAction.Builder autoScalingGroup(IAutoScalingGroup autoScalingGroup)

The auto scaling group.

Parameters:

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

Returns:

this

adjustmentType

public StepScalingAction.Builder adjustmentType(AdjustmentType adjustmentType)

How the adjustment numbers are interpreted.

Default: ChangeInCapacity

Parameters:

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

Returns:

this

cooldown

public StepScalingAction.Builder cooldown(Duration cooldown)

Period after a scaling completes before another scaling activity can start.

Default: The default cooldown configured on the AutoScalingGroup

Parameters:

cooldown - Period after a scaling completes before another scaling activity can start. This parameter is required.

Returns:

this

estimatedInstanceWarmup

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

metricAggregationType

public StepScalingAction.Builder metricAggregationType(MetricAggregationType metricAggregationType)

The aggregation type for the CloudWatch metrics.

Default: Average

Parameters:

metricAggregationType - The aggregation type for the CloudWatch metrics. This parameter is required.

Returns:

this

minAdjustmentMagnitude

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

build

public StepScalingAction build()