software.amazon.awscdk.services.autoscaling

Interface BasicStepScalingPolicyProps

All Known Subinterfaces:

StepScalingPolicyProps

All Known Implementing Classes:

BasicStepScalingPolicyProps.Jsii$Proxy, StepScalingPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.841Z")
public interface BasicStepScalingPolicyProps

Example:

 AutoScalingGroup autoScalingGroup;
 Metric workerUtilizationMetric = Metric.Builder.create()
         .namespace("MyService")
         .metricName("WorkerUtilization")
         .build();
 autoScalingGroup.scaleOnMetric("ScaleToCPU", BasicStepScalingPolicyProps.builder()
         .metric(workerUtilizationMetric)
         .scalingSteps(List.of(ScalingInterval.builder().upper(10).change(-1).build(), ScalingInterval.builder().lower(50).change(+1).build(), ScalingInterval.builder().lower(70).change(+3).build()))
         // Change this to AdjustmentType.PERCENT_CHANGE_IN_CAPACITY to interpret the
         // 'change' numbers before as percentages instead of capacity counts.
         .adjustmentType(AdjustmentType.CHANGE_IN_CAPACITY)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static BasicStepScalingPolicyProps.Builder	builder()
default AdjustmentType	getAdjustmentType() How the adjustment numbers inside 'intervals' are interpreted.
default Duration	getCooldown() Grace period after scaling activity.
default Duration	getEstimatedInstanceWarmup() Estimated time until a newly launched instance can send metrics to CloudWatch.
default java.lang.Number	getEvaluationPeriods() How many evaluation periods of the metric to wait before triggering a scaling action.
IMetric	getMetric() Metric to scale on.
default MetricAggregationType	getMetricAggregationType() Aggregation to apply to all data points over the evaluation periods.
default java.lang.Number	getMinAdjustmentMagnitude() Minimum absolute number to adjust capacity with as result of percentage scaling.
java.util.List<ScalingInterval>	getScalingSteps() The intervals for scaling.

Method Detail

getMetric

IMetric getMetric()

Metric to scale on.

getScalingSteps

java.util.List<ScalingInterval> getScalingSteps()

The intervals for scaling.

Maps a range of metric values to a particular scaling behavior.

getAdjustmentType

default AdjustmentType getAdjustmentType()

How the adjustment numbers inside 'intervals' are interpreted.

Default: ChangeInCapacity

getCooldown

default Duration getCooldown()

Grace period after scaling activity.

Default: Default cooldown period on your AutoScalingGroup

getEstimatedInstanceWarmup

default Duration getEstimatedInstanceWarmup()

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

Default: Same as the cooldown

getEvaluationPeriods

default java.lang.Number getEvaluationPeriods()

How many evaluation periods of the metric to wait before triggering a scaling action.

Raising this value can be used to smooth out the metric, at the expense of slower response times.

Default: 1

getMetricAggregationType

default MetricAggregationType getMetricAggregationType()

Aggregation to apply to all data points over the evaluation periods.

Only has meaning if evaluationPeriods != 1.

Default: - The statistic from the metric if applicable (MIN, MAX, AVERAGE), otherwise 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 BasicStepScalingPolicyProps.Builder builder()

Returns:

a BasicStepScalingPolicyProps.Builder of BasicStepScalingPolicyProps