Class StepScalingActionProps

Properties for a scaling policy.

Inheritance

System.Object

StepScalingActionProps

Implements

IStepScalingActionProps

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.AWS.AutoScaling.dll

Syntax (csharp)

public class StepScalingActionProps : Object, IStepScalingActionProps

Syntax (vb)

Public Class StepScalingActionProps
    Inherits Object
    Implements 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

Constructors

StepScalingActionProps()

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.

Constructors

StepScalingActionProps()

public StepScalingActionProps()

Properties

AdjustmentType

How the adjustment numbers are interpreted.

public Nullable<AdjustmentType> AdjustmentType { get; set; }

Property Value

System.Nullable<AdjustmentType>

Remarks

Default: ChangeInCapacity

AutoScalingGroup

The auto scaling group.

public IAutoScalingGroup AutoScalingGroup { get; set; }

Property Value

IAutoScalingGroup

Cooldown

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

public Duration Cooldown { get; set; }

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.

public Duration EstimatedInstanceWarmup { get; set; }

Property Value

Duration

Remarks

Default: Same as the cooldown

MetricAggregationType

The aggregation type for the CloudWatch metrics.

public Nullable<MetricAggregationType> MetricAggregationType { get; set; }

Property Value

System.Nullable<MetricAggregationType>

Remarks

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

Implements

IStepScalingActionProps