Interface StepScalingActionProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
StepScalingActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.95.0 (build f1ff514)", date="2024-03-26T18:09:20.019Z") @Stability(Stable) public interface StepScalingActionProps extends software.amazon.jsii.JsiiSerializable
Properties for a scaling policy.

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.autoscaling.*;
 AutoScalingGroup autoScalingGroup;
 StepScalingActionProps stepScalingActionProps = StepScalingActionProps.builder()
         .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();
 
  • Method Details

    • getAutoScalingGroup

      @Stability(Stable) @NotNull IAutoScalingGroup getAutoScalingGroup()
      The auto scaling group.
    • getAdjustmentType

      @Stability(Stable) @Nullable default AdjustmentType getAdjustmentType()
      How the adjustment numbers are interpreted.

      Default: ChangeInCapacity

    • getCooldown

      @Stability(Stable) @Nullable default Duration getCooldown()
      Period after a scaling completes before another scaling activity can start.

      Default: The default cooldown configured on the AutoScalingGroup

    • getEstimatedInstanceWarmup

      @Stability(Stable) @Nullable default Duration getEstimatedInstanceWarmup()
      Estimated time until a newly launched instance can send metrics to CloudWatch.

      Default: Same as the cooldown

    • getMetricAggregationType

      @Stability(Stable) @Nullable default MetricAggregationType getMetricAggregationType()
      The aggregation type for the CloudWatch metrics.

      Default: Average

    • getMinAdjustmentMagnitude

      @Stability(Stable) @Nullable default Number getMinAdjustmentMagnitude()
      Minimum absolute number to adjust capacity with as result of percentage scaling.

      Only when using AdjustmentType = PercentChangeInCapacity, this number controls the minimum absolute effect size.

      Default: No minimum scaling effect

    • builder

      @Stability(Stable) static StepScalingActionProps.Builder builder()
      Returns:
      a StepScalingActionProps.Builder of StepScalingActionProps