Package software.amazon.awscdk.services.applicationautoscaling

Class StepScalingAction

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.applicationautoscaling.StepScalingAction

All Implemented Interfaces:

IConstruct, IDependable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:37.376Z")
@Stability(Stable)
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.applicationautoscaling.*;
 import software.amazon.awscdk.core.*;
 ScalableTarget scalableTarget;
 StepScalingAction stepScalingAction = StepScalingAction.Builder.create(this, "MyStepScalingAction")
         .scalingTarget(scalableTarget)
         // the properties below are optional
         .adjustmentType(AdjustmentType.CHANGE_IN_CAPACITY)
         .cooldown(Duration.minutes(30))
         .metricAggregationType(MetricAggregationType.AVERAGE)
         .minAdjustmentMagnitude(123)
         .policyName("policyName")
         .build();
 

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addAdjustment(AdjustmentTier adjustment)	Add an adjusment interval to the ScalingAction.
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 software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

StepScalingAction

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

StepScalingAction

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

StepScalingAction

@Stability(Stable)
public StepScalingAction(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 StepScalingActionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

addAdjustment

@Stability(Stable)
public void addAdjustment(@NotNull
 AdjustmentTier adjustment)

Add an adjusment interval to the ScalingAction.

Parameters:

adjustment - This parameter is required.

getScalingPolicyArn

@Stability(Stable)
@NotNull
public String getScalingPolicyArn()

ARN of the scaling policy.