Class BasicStepScalingPolicyProps
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class BasicStepScalingPolicyProps : Object, IBasicStepScalingPolicyProps
Syntax (vb)
Public Class BasicStepScalingPolicyProps
Inherits Object
Implements IBasicStepScalingPolicyProps
Remarks
ExampleMetadata: infused
Examples
AutoScalingGroup autoScalingGroup;
var workerUtilizationMetric = new Metric(new MetricProps {
Namespace = "MyService",
MetricName = "WorkerUtilization"
});
autoScalingGroup.ScaleOnMetric("ScaleToCPU", new BasicStepScalingPolicyProps {
Metric = workerUtilizationMetric,
ScalingSteps = new [] { new ScalingInterval { Upper = 10, Change = -1 }, new ScalingInterval { Lower = 50, Change = +1 }, new ScalingInterval { Lower = 70, Change = +3 } },
EvaluationPeriods = 10,
DatapointsToAlarm = 5,
// 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
});
Synopsis
Constructors
BasicStepScalingPolicyProps() |
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. |
EstimatedInstanceWarmup | Estimated time until a newly launched instance can send metrics to CloudWatch. |
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. |
Constructors
BasicStepScalingPolicyProps()
public BasicStepScalingPolicyProps()
Properties
AdjustmentType
How the adjustment numbers inside 'intervals' are interpreted.
public Nullable<AdjustmentType> AdjustmentType { get; set; }
Property Value
System.Nullable<AdjustmentType>
Remarks
Default: ChangeInCapacity
Cooldown
Grace period after scaling activity.
public Duration Cooldown { get; set; }
Property Value
Remarks
Default: Default cooldown period on your AutoScalingGroup
DatapointsToAlarm
The number of data points out of the evaluation periods that must be breaching to trigger a scaling action.
public Nullable<double> DatapointsToAlarm { get; set; }
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
. Must be less than or equal to
evaluationPeriods
.
Default: - Same as evaluationPeriods
EstimatedInstanceWarmup
Estimated time until a newly launched instance can send metrics to CloudWatch.
public Duration EstimatedInstanceWarmup { get; set; }
Property Value
Remarks
Default: Same as the cooldown
EvaluationPeriods
How many evaluation periods of the metric to wait before triggering a scaling action.
public Nullable<double> EvaluationPeriods { get; set; }
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
MetricAggregationType
Aggregation to apply to all data points over the evaluation periods.
public Nullable<MetricAggregationType> MetricAggregationType { get; set; }
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.
public Nullable<double> MinAdjustmentMagnitude { get; set; }
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.
public IScalingInterval[] ScalingSteps { get; set; }
Property Value
Remarks
Maps a range of metric values to a particular scaling behavior.
Must be between 2 and 40 steps.