software.amazon.awscdk.services.autoscaling

Interface StepScalingActionProps

All Known Implementing Classes:

StepScalingActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:58.618Z")
public interface StepScalingActionProps

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static StepScalingActionProps.Builder	builder()
default AdjustmentType	getAdjustmentType() How the adjustment numbers are interpreted.
IAutoScalingGroup	getAutoScalingGroup() The auto scaling group.
default Duration	getCooldown() Period after a scaling completes before another scaling activity can start.
default Duration	getEstimatedInstanceWarmup() Estimated time until a newly launched instance can send metrics to CloudWatch.
default MetricAggregationType	getMetricAggregationType() The aggregation type for the CloudWatch metrics.
default java.lang.Number	getMinAdjustmentMagnitude() Minimum absolute number to adjust capacity with as result of percentage scaling.

Method Detail

getAutoScalingGroup

IAutoScalingGroup getAutoScalingGroup()

The auto scaling group.

getAdjustmentType

default AdjustmentType getAdjustmentType()

How the adjustment numbers are interpreted.

Default: ChangeInCapacity

getCooldown

default Duration getCooldown()

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

Default: The default cooldown configured on the AutoScalingGroup

getEstimatedInstanceWarmup

default Duration getEstimatedInstanceWarmup()

Estimated time until a newly launched instance can send metrics to CloudWatch.

Default: Same as the cooldown

getMetricAggregationType

default MetricAggregationType getMetricAggregationType()

The aggregation type for the CloudWatch metrics.

Default: Average

getMinAdjustmentMagnitude

default java.lang.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

builder

static StepScalingActionProps.Builder builder()

Returns:

a StepScalingActionProps.Builder of StepScalingActionProps