Interface IStepScalingActionProps

Properties for a scaling policy.

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.AWS.AutoScaling.dll

Syntax (csharp)

public interface IStepScalingActionProps

Syntax (vb)

Public Interface IStepScalingActionProps

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AutoScaling;
using Amazon.CDK;

AutoScalingGroup autoScalingGroup;
var stepScalingActionProps = new StepScalingActionProps {
    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
};

Synopsis

Properties

AdjustmentType	How the adjustment numbers are interpreted.
AutoScalingGroup	The auto scaling group.
Cooldown	Period after a scaling completes before another scaling activity can start.
EstimatedInstanceWarmup	Estimated time until a newly launched instance can send metrics to CloudWatch.
MetricAggregationType	The aggregation type for the CloudWatch metrics.
MinAdjustmentMagnitude	Minimum absolute number to adjust capacity with as result of percentage scaling.

Properties

AdjustmentType

How the adjustment numbers are interpreted.

virtual Nullable<AdjustmentType> AdjustmentType { get; }

Property Value

System.Nullable<AdjustmentType>

Remarks

Default: ChangeInCapacity

AutoScalingGroup

The auto scaling group.

IAutoScalingGroup AutoScalingGroup { get; }

Property Value

IAutoScalingGroup

Cooldown

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

virtual Duration Cooldown { get; }

Property Value

Duration

Remarks

Default: The default cooldown configured on the AutoScalingGroup

EstimatedInstanceWarmup

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

virtual Duration EstimatedInstanceWarmup { get; }

Property Value

Duration

Remarks

Default: Same as the cooldown

MetricAggregationType

The aggregation type for the CloudWatch metrics.

virtual Nullable<MetricAggregationType> MetricAggregationType { get; }

Property Value

System.Nullable<MetricAggregationType>

Remarks

Default: 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