Package software.amazon.awscdk.services.applicationautoscaling

Interface CfnScalingPolicy.StepScalingPolicyConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnScalingPolicy

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

StepScalingPolicyConfiguration is a property of the AWS::ApplicationAutoScaling::ScalingPolicy resource that specifies a step scaling policy configuration for Application Auto Scaling.

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

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.*;
 StepScalingPolicyConfigurationProperty stepScalingPolicyConfigurationProperty = StepScalingPolicyConfigurationProperty.builder()
         .adjustmentType("adjustmentType")
         .cooldown(123)
         .metricAggregationType("metricAggregationType")
         .minAdjustmentMagnitude(123)
         .stepAdjustments(List.of(StepAdjustmentProperty.builder()
                 .scalingAdjustment(123)
                 // the properties below are optional
                 .metricIntervalLowerBound(123)
                 .metricIntervalUpperBound(123)
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder	builder()
default String	getAdjustmentType()	Specifies whether the ScalingAdjustment value in the StepAdjustment property is an absolute number or a percentage of the current capacity.
default Number	getCooldown()	The amount of time, in seconds, to wait for a previous scaling activity to take effect.
default String	getMetricAggregationType()	The aggregation type for the CloudWatch metrics.
default Number	getMinAdjustmentMagnitude()	The minimum value to scale by when the adjustment type is PercentChangeInCapacity .
default Object	getStepAdjustments()	A set of adjustments that enable you to scale based on the size of the alarm breach.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdjustmentType

@Stability(Stable)
@Nullable
default String getAdjustmentType()

Specifies whether the ScalingAdjustment value in the StepAdjustment property is an absolute number or a percentage of the current capacity.

See Also:

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

getCooldown

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

The amount of time, in seconds, to wait for a previous scaling activity to take effect.

If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide .

See Also:

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

getMetricAggregationType

@Stability(Stable)
@Nullable
default String getMetricAggregationType()

The aggregation type for the CloudWatch metrics.

Valid values are Minimum , Maximum , and Average . If the aggregation type is null, the value is treated as Average .

See Also:

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

getMinAdjustmentMagnitude

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

The minimum value to scale by when the adjustment type is PercentChangeInCapacity .

For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.

See Also:

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

getStepAdjustments

@Stability(Stable)
@Nullable
default Object getStepAdjustments()

A set of adjustments that enable you to scale based on the size of the alarm breach.

At least one step adjustment is required if you are adding a new step scaling policy configuration.

See Also:

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

builder

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

Returns:

a CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder of CfnScalingPolicy.StepScalingPolicyConfigurationProperty