Package software.amazon.awscdk.services.autoscaling

Class CfnScalingPolicyProps.Builder

java.lang.Object
software.amazon.awscdk.services.autoscaling.CfnScalingPolicyProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnScalingPolicyProps>
Enclosing interface:
CfnScalingPolicyProps
@Stability(Stable) public static final class CfnScalingPolicyProps.Builder extends Object implements software.amazon.jsii.Builder<CfnScalingPolicyProps>
A builder for CfnScalingPolicyProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • autoScalingGroupName

      @Stability(Stable) public CfnScalingPolicyProps.Builder autoScalingGroupName(String autoScalingGroupName)
      Sets the value of CfnScalingPolicyProps.getAutoScalingGroupName()
      Parameters:
      autoScalingGroupName - The name of the Auto Scaling group. This parameter is required.
      Returns:
      this

    • adjustmentType

      @Stability(Stable) public CfnScalingPolicyProps.Builder adjustmentType(String adjustmentType)
      Sets the value of CfnScalingPolicyProps.getAdjustmentType()
      Parameters:
      adjustmentType - Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity , ExactCapacity , and PercentChangeInCapacity .

      Required if the policy type is StepScaling or SimpleScaling . For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide .

      Returns:
      this

    • cooldown

      @Stability(Stable) public CfnScalingPolicyProps.Builder cooldown(String cooldown)
      Sets the value of CfnScalingPolicyProps.getCooldown()
      Parameters:
      cooldown - A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.

      Valid only if the policy type is SimpleScaling . For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

      Default: None

      Returns:
      this

    • estimatedInstanceWarmup

      @Stability(Stable) public CfnScalingPolicyProps.Builder estimatedInstanceWarmup(Number estimatedInstanceWarmup)
      Sets the value of CfnScalingPolicyProps.getEstimatedInstanceWarmup()
      Parameters:
      estimatedInstanceWarmup - Not needed if the default instance warmup is defined for the group.. The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.

      Valid only if the policy type is TargetTrackingScaling or StepScaling .

      The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.

      Returns:
      this

    • metricAggregationType

      @Stability(Stable) public CfnScalingPolicyProps.Builder metricAggregationType(String metricAggregationType)
      Sets the value of CfnScalingPolicyProps.getMetricAggregationType()
      Parameters:
      metricAggregationType - The aggregation type for the CloudWatch metrics. The valid values are Minimum , Maximum , and Average . If the aggregation type is null, the value is treated as Average .

      Valid only if the policy type is StepScaling .

      Returns:
      this

    • minAdjustmentMagnitude

      @Stability(Stable) public CfnScalingPolicyProps.Builder minAdjustmentMagnitude(Number minAdjustmentMagnitude)
      Sets the value of CfnScalingPolicyProps.getMinAdjustmentMagnitude()
      Parameters:
      minAdjustmentMagnitude - The minimum value to scale by when the adjustment type is PercentChangeInCapacity . For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

      Valid only if the policy type is StepScaling or SimpleScaling . For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide .

      Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest instance weight.

      Returns:
      this

    • policyType

      @Stability(Stable) public CfnScalingPolicyProps.Builder policyType(String policyType)
      Sets the value of CfnScalingPolicyProps.getPolicyType()
      Parameters:
      policyType - One of the following policy types:.
      • TargetTrackingScaling
      • StepScaling
      • SimpleScaling (default)
      • PredictiveScaling
      Returns:
      this

    • predictiveScalingConfiguration

      @Stability(Stable) public CfnScalingPolicyProps.Builder predictiveScalingConfiguration(IResolvable predictiveScalingConfiguration)
      Sets the value of CfnScalingPolicyProps.getPredictiveScalingConfiguration()
      Parameters:
      predictiveScalingConfiguration - A predictive scaling policy. Provides support for predefined and custom metrics. Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.

      Required if the policy type is PredictiveScaling .

      Returns:
      this

    • predictiveScalingConfiguration

      @Stability(Stable) public CfnScalingPolicyProps.Builder predictiveScalingConfiguration(CfnScalingPolicy.PredictiveScalingConfigurationProperty predictiveScalingConfiguration)
      Sets the value of CfnScalingPolicyProps.getPredictiveScalingConfiguration()
      Parameters:
      predictiveScalingConfiguration - A predictive scaling policy. Provides support for predefined and custom metrics. Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.

      Required if the policy type is PredictiveScaling .

      Returns:
      this

    • scalingAdjustment

      @Stability(Stable) public CfnScalingPolicyProps.Builder scalingAdjustment(Number scalingAdjustment)
      Sets the value of CfnScalingPolicyProps.getScalingAdjustment()
      Parameters:
      scalingAdjustment - The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value.

      Required if the policy type is SimpleScaling . (Not used with any other policy type.)

      Returns:
      this

    • stepAdjustments

      @Stability(Stable) public CfnScalingPolicyProps.Builder stepAdjustments(IResolvable stepAdjustments)
      Sets the value of CfnScalingPolicyProps.getStepAdjustments()
      Parameters:
      stepAdjustments - A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling . (Not used with any other policy type.)
      Returns:
      this

    • stepAdjustments

      @Stability(Stable) public CfnScalingPolicyProps.Builder stepAdjustments(List<? extends Object> stepAdjustments)
      Sets the value of CfnScalingPolicyProps.getStepAdjustments()
      Parameters:
      stepAdjustments - A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling . (Not used with any other policy type.)
      Returns:
      this

    • targetTrackingConfiguration

      @Stability(Stable) public CfnScalingPolicyProps.Builder targetTrackingConfiguration(IResolvable targetTrackingConfiguration)
      Sets the value of CfnScalingPolicyProps.getTargetTrackingConfiguration()
      Parameters:
      targetTrackingConfiguration - A target tracking scaling policy. Provides support for predefined or custom metrics. The following predefined metrics are available:

      • ASGAverageCPUUtilization
      • ASGAverageNetworkIn
      • ASGAverageNetworkOut
      • ALBRequestCountPerTarget

      If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification .

      Required if the policy type is TargetTrackingScaling .

      Returns:
      this

    • targetTrackingConfiguration

      @Stability(Stable) public CfnScalingPolicyProps.Builder targetTrackingConfiguration(CfnScalingPolicy.TargetTrackingConfigurationProperty targetTrackingConfiguration)
      Sets the value of CfnScalingPolicyProps.getTargetTrackingConfiguration()
      Parameters:
      targetTrackingConfiguration - A target tracking scaling policy. Provides support for predefined or custom metrics. The following predefined metrics are available:

      • ASGAverageCPUUtilization
      • ASGAverageNetworkIn
      • ASGAverageNetworkOut
      • ALBRequestCountPerTarget

      If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification .

      Required if the policy type is TargetTrackingScaling .

      Returns:
      this

    • build

      @Stability(Stable) public CfnScalingPolicyProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnScalingPolicyProps>
      Returns:
      a new instance of CfnScalingPolicyProps
      Throws:
      NullPointerException - if any required attribute was not provided