Package software.amazon.awssdk.services.autoscalingplans.model

Interface TargetTrackingConfiguration.Builder

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

  • Method Details

    • predefinedScalingMetricSpecification

      TargetTrackingConfiguration.Builder predefinedScalingMetricSpecification(PredefinedScalingMetricSpecification predefinedScalingMetricSpecification)

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

      Parameters:
      predefinedScalingMetricSpecification - 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.

    • predefinedScalingMetricSpecification

      default TargetTrackingConfiguration.Builder predefinedScalingMetricSpecification(Consumer<PredefinedScalingMetricSpecification.Builder> predefinedScalingMetricSpecification)

      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 PredefinedScalingMetricSpecification.Builder avoiding the need to create one manually via PredefinedScalingMetricSpecification.builder().

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

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

    • customizedScalingMetricSpecification

      TargetTrackingConfiguration.Builder customizedScalingMetricSpecification(CustomizedScalingMetricSpecification customizedScalingMetricSpecification)

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

      Parameters:
      customizedScalingMetricSpecification - 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.

    • customizedScalingMetricSpecification

      default TargetTrackingConfiguration.Builder customizedScalingMetricSpecification(Consumer<CustomizedScalingMetricSpecification.Builder> customizedScalingMetricSpecification)

      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 CustomizedScalingMetricSpecification.Builder avoiding the need to create one manually via CustomizedScalingMetricSpecification.builder().

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

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

    • targetValue

      TargetTrackingConfiguration.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.

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disableScaleIn

      TargetTrackingConfiguration.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 doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource.

      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 doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource.

      The default value is false.

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

    • scaleOutCooldown

      TargetTrackingConfiguration.Builder scaleOutCooldown(Integer scaleOutCooldown)

      The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.

      With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.

      Parameters:
      scaleOutCooldown - The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.

      With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.

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

    • scaleInCooldown

      TargetTrackingConfiguration.Builder scaleInCooldown(Integer scaleInCooldown)

      The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group.

      With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

      Parameters:
      scaleInCooldown - The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group.

      With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

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

    • estimatedInstanceWarmup

      TargetTrackingConfiguration.Builder estimatedInstanceWarmup(Integer estimatedInstanceWarmup)

      The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

      Parameters:
      estimatedInstanceWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.