Package software.amazon.awssdk.services.applicationautoscaling.model

Interface TargetTrackingScalingPolicyConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TargetTrackingScalingPolicyConfiguration.Builder,TargetTrackingScalingPolicyConfiguration>, SdkBuilder<TargetTrackingScalingPolicyConfiguration.Builder,TargetTrackingScalingPolicyConfiguration>, SdkPojo
Enclosing class:
TargetTrackingScalingPolicyConfiguration
public static interface TargetTrackingScalingPolicyConfiguration.Builder extends SdkPojo, CopyableBuilder<TargetTrackingScalingPolicyConfiguration.Builder,TargetTrackingScalingPolicyConfiguration>

  • Method Details

    • targetValue

      TargetTrackingScalingPolicyConfiguration.Builder targetValue(Double targetValue)

      The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.

      If the scaling policy specifies the ALBRequestCountPerTarget predefined metric, specify the target utilization as the optimal average request count per target during any one-minute interval.

      Parameters:
      targetValue - The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.

      If the scaling policy specifies the ALBRequestCountPerTarget predefined metric, specify the target utilization as the optimal average request count per target during any one-minute interval.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • predefinedMetricSpecification

      TargetTrackingScalingPolicyConfiguration.Builder predefinedMetricSpecification(PredefinedMetricSpecification predefinedMetricSpecification)

      A predefined metric. You can specify either a predefined metric or a customized metric.

      Parameters:
      predefinedMetricSpecification - A predefined metric. You can specify either a predefined metric or a customized metric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • predefinedMetricSpecification

      default TargetTrackingScalingPolicyConfiguration.Builder predefinedMetricSpecification(Consumer<PredefinedMetricSpecification.Builder> predefinedMetricSpecification)

      A predefined metric. You can specify either a predefined metric or a customized metric.

      This is a convenience method that creates an instance of the PredefinedMetricSpecification.Builder avoiding the need to create one manually via PredefinedMetricSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to predefinedMetricSpecification(PredefinedMetricSpecification).

      Parameters:
      predefinedMetricSpecification - a consumer that will call methods on PredefinedMetricSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customizedMetricSpecification

      TargetTrackingScalingPolicyConfiguration.Builder customizedMetricSpecification(CustomizedMetricSpecification customizedMetricSpecification)

      A customized metric. You can specify either a predefined metric or a customized metric.

      Parameters:
      customizedMetricSpecification - A customized metric. You can specify either a predefined metric or a customized metric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customizedMetricSpecification

      default TargetTrackingScalingPolicyConfiguration.Builder customizedMetricSpecification(Consumer<CustomizedMetricSpecification.Builder> customizedMetricSpecification)

      A customized metric. You can specify either a predefined metric or a customized metric.

      This is a convenience method that creates an instance of the CustomizedMetricSpecification.Builder avoiding the need to create one manually via CustomizedMetricSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customizedMetricSpecification(CustomizedMetricSpecification).

      Parameters:
      customizedMetricSpecification - a consumer that will call methods on CustomizedMetricSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scaleOutCooldown

      TargetTrackingScalingPolicyConfiguration.Builder scaleOutCooldown(Integer scaleOutCooldown)

      The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

      Parameters:
      scaleOutCooldown - The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scaleInCooldown

      TargetTrackingScalingPolicyConfiguration.Builder scaleInCooldown(Integer scaleInCooldown)

      The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

      Parameters:
      scaleInCooldown - The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disableScaleIn

      TargetTrackingScalingPolicyConfiguration.Builder disableScaleIn(Boolean disableScaleIn)

      Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.

      Parameters:
      disableScaleIn - Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.