Class StepScalingAction.Builder

java.lang.Object
software.amazon.awscdk.services.autoscaling.StepScalingAction.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<StepScalingAction>
Enclosing class:
StepScalingAction

@Stability(Stable) public static final class StepScalingAction.Builder extends Object implements software.amazon.jsii.Builder<StepScalingAction>
A fluent builder for StepScalingAction.
  • Method Details

    • create

      @Stability(Stable) public static StepScalingAction.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of StepScalingAction.Builder.
    • autoScalingGroup

      @Stability(Stable) public StepScalingAction.Builder autoScalingGroup(IAutoScalingGroup autoScalingGroup)
      The auto scaling group.

      Parameters:
      autoScalingGroup - The auto scaling group. This parameter is required.
      Returns:
      this
    • adjustmentType

      @Stability(Stable) public StepScalingAction.Builder adjustmentType(AdjustmentType adjustmentType)
      How the adjustment numbers are interpreted.

      Default: ChangeInCapacity

      Parameters:
      adjustmentType - How the adjustment numbers are interpreted. This parameter is required.
      Returns:
      this
    • cooldown

      @Stability(Stable) public StepScalingAction.Builder cooldown(Duration cooldown)
      Period after a scaling completes before another scaling activity can start.

      Default: The default cooldown configured on the AutoScalingGroup

      Parameters:
      cooldown - Period after a scaling completes before another scaling activity can start. This parameter is required.
      Returns:
      this
    • estimatedInstanceWarmup

      @Stability(Stable) public StepScalingAction.Builder estimatedInstanceWarmup(Duration estimatedInstanceWarmup)
      Estimated time until a newly launched instance can send metrics to CloudWatch.

      Default: Same as the cooldown

      Parameters:
      estimatedInstanceWarmup - Estimated time until a newly launched instance can send metrics to CloudWatch. This parameter is required.
      Returns:
      this
    • metricAggregationType

      @Stability(Stable) public StepScalingAction.Builder metricAggregationType(MetricAggregationType metricAggregationType)
      The aggregation type for the CloudWatch metrics.

      Default: Average

      Parameters:
      metricAggregationType - The aggregation type for the CloudWatch metrics. This parameter is required.
      Returns:
      this
    • minAdjustmentMagnitude

      @Stability(Stable) public StepScalingAction.Builder minAdjustmentMagnitude(Number minAdjustmentMagnitude)
      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

      Parameters:
      minAdjustmentMagnitude - Minimum absolute number to adjust capacity with as result of percentage scaling. This parameter is required.
      Returns:
      this
    • build

      @Stability(Stable) public StepScalingAction build()
      Specified by:
      build in interface software.amazon.jsii.Builder<StepScalingAction>
      Returns:
      a newly built instance of StepScalingAction.