Interface IBasicStepScalingPolicyProps

Namespace: Amazon.CDK.AWS.ApplicationAutoScaling

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IBasicStepScalingPolicyProps

Syntax (vb)

Public Interface IBasicStepScalingPolicyProps

Remarks

ExampleMetadata: infused

Examples

ScalableAttribute capacity;
Metric cpuUtilization;


capacity.ScaleOnMetric("ScaleToCPU", new BasicStepScalingPolicyProps {
    Metric = cpuUtilization,
    ScalingSteps = new [] { new ScalingInterval { Upper = 10, Change = -1 }, new ScalingInterval { Lower = 50, Change = +1 }, new ScalingInterval { Lower = 70, Change = +3 } },

    // Change this to AdjustmentType.PercentChangeInCapacity to interpret the
    // 'change' numbers before as percentages instead of capacity counts.
    AdjustmentType = AdjustmentType.CHANGE_IN_CAPACITY
});

Synopsis

Properties

AdjustmentType	How the adjustment numbers inside 'intervals' are interpreted.
Cooldown	Grace period after scaling activity.
DatapointsToAlarm	The number of data points out of the evaluation periods that must be breaching to trigger a scaling action.
EvaluationPeriods	How many evaluation periods of the metric to wait before triggering a scaling action.
Metric	Metric to scale on.
MetricAggregationType	Aggregation to apply to all data points over the evaluation periods.
MinAdjustmentMagnitude	Minimum absolute number to adjust capacity with as result of percentage scaling.
ScalingSteps	The intervals for scaling.

Properties

AdjustmentType

How the adjustment numbers inside 'intervals' are interpreted.

virtual Nullable<AdjustmentType> AdjustmentType { get; }

Property Value

System.Nullable<AdjustmentType>

Remarks

Default: ChangeInCapacity

Cooldown

Grace period after scaling activity.

virtual Duration Cooldown { get; }

Property Value

Duration

Remarks

Subsequent scale outs during the cooldown period are squashed so that only the biggest scale out happens.

Subsequent scale ins during the cooldown period are ignored.

Default: No cooldown period

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

DatapointsToAlarm

The number of data points out of the evaluation periods that must be breaching to trigger a scaling action.

virtual Nullable<double> DatapointsToAlarm { get; }

Property Value

System.Nullable<System.Double>

Remarks

Creates an "M out of N" alarm, where this property is the M and the value set for evaluationPeriods is the N value.

Only has meaning if evaluationPeriods != 1.

Default: - Same as evaluationPeriods

EvaluationPeriods

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

virtual Nullable<double> EvaluationPeriods { get; }

Property Value

System.Nullable<System.Double>

Remarks

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

If datapointsToAlarm is not set, then all data points in the evaluation period must meet the criteria to trigger a scaling action.

Default: 1

Metric

Metric to scale on.

IMetric Metric { get; }

Property Value

IMetric

MetricAggregationType

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

virtual Nullable<MetricAggregationType> MetricAggregationType { get; }

Property Value

System.Nullable<MetricAggregationType>

Remarks

Only has meaning if evaluationPeriods != 1.

Default: - The statistic from the metric if applicable (MIN, MAX, AVERAGE), otherwise AVERAGE.

MinAdjustmentMagnitude

Minimum absolute number to adjust capacity with as result of percentage scaling.

virtual Nullable<double> MinAdjustmentMagnitude { get; }

Property Value

System.Nullable<System.Double>

Remarks

Only when using AdjustmentType = PercentChangeInCapacity, this number controls the minimum absolute effect size.

Default: No minimum scaling effect

ScalingSteps

The intervals for scaling.

IScalingInterval[] ScalingSteps { get; }

Property Value

IScalingInterval[]

Remarks

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

Must be between 2 and 40 steps.