Package software.amazon.awscdk.services.applicationautoscaling

Interface CfnScalingPolicy.StepAdjustmentProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPolicy.StepAdjustmentProperty.Jsii$Proxy

Enclosing class:

CfnScalingPolicy

@Stability(Stable)
public static interface CfnScalingPolicy.StepAdjustmentProperty
extends software.amazon.jsii.JsiiSerializable

StepAdjustment specifies a step adjustment for the StepAdjustments property of the AWS::ApplicationAutoScaling::ScalingPolicy StepScalingPolicyConfiguration property type.

For the following examples, suppose that you have an alarm with a breach threshold of 50:

• To trigger a step adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.
• To trigger a step adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.

For more information, see Step adjustments in the Application Auto Scaling User Guide .

You can find a sample template snippet in the Examples section of the AWS::ApplicationAutoScaling::ScalingPolicy documentation.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.applicationautoscaling.*;
 StepAdjustmentProperty stepAdjustmentProperty = StepAdjustmentProperty.builder()
         .scalingAdjustment(123)
         // the properties below are optional
         .metricIntervalLowerBound(123)
         .metricIntervalUpperBound(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepadjustment.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnScalingPolicy.StepAdjustmentProperty.Builder	A builder for CfnScalingPolicy.StepAdjustmentProperty
static final class	CfnScalingPolicy.StepAdjustmentProperty.Jsii$Proxy	An implementation for CfnScalingPolicy.StepAdjustmentProperty

Method Summary

Modifier and Type	Method	Description
static CfnScalingPolicy.StepAdjustmentProperty.Builder	builder()
default Number	getMetricIntervalLowerBound()	The lower bound for the difference between the alarm threshold and the CloudWatch metric.
default Number	getMetricIntervalUpperBound()	The upper bound for the difference between the alarm threshold and the CloudWatch metric.
Number	getScalingAdjustment()	The amount by which to scale.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getScalingAdjustment

@Stability(Stable)
@NotNull
Number getScalingAdjustment()

The amount by which to scale.

The adjustment is based on the value that you specified in the AdjustmentType property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepadjustment-scalingadjustment

getMetricIntervalLowerBound

@Stability(Stable)
@Nullable
default Number getMetricIntervalLowerBound()

The lower bound for the difference between the alarm threshold and the CloudWatch metric.

If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.

You must specify at least one upper or lower bound.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepadjustment-metricintervallowerbound

getMetricIntervalUpperBound

@Stability(Stable)
@Nullable
default Number getMetricIntervalUpperBound()

The upper bound for the difference between the alarm threshold and the CloudWatch metric.

If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.

You must specify at least one upper or lower bound.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepadjustment-metricintervalupperbound

builder

@Stability(Stable)
static CfnScalingPolicy.StepAdjustmentProperty.Builder builder()

Returns:

a CfnScalingPolicy.StepAdjustmentProperty.Builder of CfnScalingPolicy.StepAdjustmentProperty