software.amazon.awscdk.services.applicationautoscaling

Class StepScalingAction.Builder

java.lang.Object

software.amazon.awscdk.services.applicationautoscaling.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	build()
StepScalingAction.Builder	cooldown(Duration cooldown) Grace period after scaling activity.
static StepScalingAction.Builder	create(software.constructs.Construct scope, java.lang.String id)
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.
StepScalingAction.Builder	policyName(java.lang.String policyName) A name for the scaling policy.
StepScalingAction.Builder	scalingTarget(IScalableTarget scalingTarget) The scalable target.

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.

scalingTarget

public StepScalingAction.Builder scalingTarget(IScalableTarget scalingTarget)

The scalable target.

Parameters:

scalingTarget - The scalable target. 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)

Grace period after scaling activity.

For scale out policies, multiple scale outs during the cooldown period are squashed so that only the biggest scale out happens.

For scale in policies, 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

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

policyName

public StepScalingAction.Builder policyName(java.lang.String policyName)

A name for the scaling policy.

Default: Automatically generated name

Parameters:

policyName - A name for the scaling policy. This parameter is required.

Returns:

this

build

public StepScalingAction build()