Package software.amazon.awscdk.services.applicationautoscaling

Class StepScalingPolicy

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.services.applicationautoscaling.StepScalingPolicy
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:12.376Z") @Stability(Stable) public class StepScalingPolicy extends software.constructs.Construct
Define a scaling strategy which scales depending on absolute values of some metric.

You can specify the scaling behavior for various values of the metric.

Implemented using one or more CloudWatch alarms and Step Scaling Policies.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.applicationautoscaling.*;
 import software.amazon.awscdk.services.cloudwatch.*;
 Metric metric;
 ScalableTarget scalableTarget;
 StepScalingPolicy stepScalingPolicy = StepScalingPolicy.Builder.create(this, "MyStepScalingPolicy")
         .metric(metric)
         .scalingSteps(List.of(ScalingInterval.builder()
                 .change(123)
                 // the properties below are optional
                 .lower(123)
                 .upper(123)
                 .build()))
         .scalingTarget(scalableTarget)
         // the properties below are optional
         .adjustmentType(AdjustmentType.CHANGE_IN_CAPACITY)
         .cooldown(Duration.minutes(30))
         .datapointsToAlarm(123)
         .evaluationPeriods(123)
         .metricAggregationType(MetricAggregationType.AVERAGE)
         .minAdjustmentMagnitude(123)
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    StepScalingPolicy.Builder
    A fluent builder for StepScalingPolicy.

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

    software.amazon.jsii.JsiiObject.InitializationMode

    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
    StepScalingPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    StepScalingPolicy(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    StepScalingPolicy(software.constructs.Construct scope, String id, StepScalingPolicyProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    StepScalingAction
    getLowerAction()
     
    Alarm
    getLowerAlarm()
     
    StepScalingAction
    getUpperAction()
     
    Alarm
    getUpperAlarm()
     

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, 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

    • StepScalingPolicy

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

    • StepScalingPolicy

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

    • StepScalingPolicy

      @Stability(Stable) public StepScalingPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull StepScalingPolicyProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • getLowerAction

      @Stability(Stable) @Nullable public StepScalingAction getLowerAction()

    • getLowerAlarm

      @Stability(Stable) @Nullable public Alarm getLowerAlarm()

    • getUpperAction

      @Stability(Stable) @Nullable public StepScalingAction getUpperAction()

    • getUpperAlarm

      @Stability(Stable) @Nullable public Alarm getUpperAlarm()