software.amazon.awscdk.services.autoscaling

Class StepScalingAction

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.autoscaling.StepScalingAction

All Implemented Interfaces:

IConstruct, IDependable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.023Z")
public class StepScalingAction
extends Construct

Define a step scaling action.

This kind of scaling policy adjusts the target capacity in configurable steps. The size of the step is configurable based on the metric's distance to its alarm threshold.

This Action must be used as the target of a CloudWatch alarm to take effect.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.autoscaling.*;
 import software.amazon.awscdk.core.*;
 AutoScalingGroup autoScalingGroup;
 StepScalingAction stepScalingAction = StepScalingAction.Builder.create(this, "MyStepScalingAction")
         .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)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StepScalingAction.Builder A fluent builder for StepScalingAction.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StepScalingAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	StepScalingAction(software.amazon.jsii.JsiiObjectRef objRef)
	StepScalingAction(software.constructs.Construct scope, java.lang.String id, StepScalingActionProps props)

Method Summary

Modifier and Type	Method and Description
void	addAdjustment(AdjustmentTier adjustment) Add an adjusment interval to the ScalingAction.
java.lang.String	getScalingPolicyArn() ARN of the scaling policy.

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StepScalingAction

protected StepScalingAction(software.amazon.jsii.JsiiObjectRef objRef)

StepScalingAction

protected StepScalingAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

StepScalingAction

public StepScalingAction(software.constructs.Construct scope,
                         java.lang.String id,
                         StepScalingActionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

addAdjustment

public void addAdjustment(AdjustmentTier adjustment)

Add an adjusment interval to the ScalingAction.

Parameters:

adjustment - This parameter is required.

getScalingPolicyArn

public java.lang.String getScalingPolicyArn()

ARN of the scaling policy.