Package software.amazon.awscdk.services.applicationautoscaling

Interface StepScalingActionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StepScalingActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:37.377Z")
@Stability(Stable)
public interface StepScalingActionProps
extends software.amazon.jsii.JsiiSerializable

Properties for a scaling policy.

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.*;
 import software.amazon.awscdk.core.*;
 ScalableTarget scalableTarget;
 StepScalingActionProps stepScalingActionProps = StepScalingActionProps.builder()
         .scalingTarget(scalableTarget)
         // the properties below are optional
         .adjustmentType(AdjustmentType.CHANGE_IN_CAPACITY)
         .cooldown(Duration.minutes(30))
         .metricAggregationType(MetricAggregationType.AVERAGE)
         .minAdjustmentMagnitude(123)
         .policyName("policyName")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static StepScalingActionProps.Builder	builder()
default AdjustmentType	getAdjustmentType()	How the adjustment numbers are interpreted.
default Duration	getCooldown()	Grace period after scaling activity.
default MetricAggregationType	getMetricAggregationType()	The aggregation type for the CloudWatch metrics.
default Number	getMinAdjustmentMagnitude()	Minimum absolute number to adjust capacity with as result of percentage scaling.
default String	getPolicyName()	A name for the scaling policy.
IScalableTarget	getScalingTarget()	The scalable target.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getScalingTarget

@Stability(Stable)
@NotNull
IScalableTarget getScalingTarget()

The scalable target.

getAdjustmentType

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

How the adjustment numbers are interpreted.

Default: ChangeInCapacity

getCooldown

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

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

See Also:

• https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html

getMetricAggregationType

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

The aggregation type for the CloudWatch metrics.

Default: Average

getMinAdjustmentMagnitude

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

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

getPolicyName

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

A name for the scaling policy.

Default: Automatically generated name

builder

@Stability(Stable)
static StepScalingActionProps.Builder builder()

Returns:

a StepScalingActionProps.Builder of StepScalingActionProps