Interface PredictiveScalingPolicyConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PredictiveScalingPolicyConfiguration.Builder,PredictiveScalingPolicyConfiguration>, SdkBuilder<PredictiveScalingPolicyConfiguration.Builder,PredictiveScalingPolicyConfiguration>, SdkPojo
Enclosing class:
PredictiveScalingPolicyConfiguration
@Mutable @NotThreadSafe public static interface PredictiveScalingPolicyConfiguration.Builder extends SdkPojo, CopyableBuilder<PredictiveScalingPolicyConfiguration.Builder,PredictiveScalingPolicyConfiguration>

  • Method Details

    • metricSpecifications

      PredictiveScalingPolicyConfiguration.Builder metricSpecifications(Collection<PredictiveScalingMetricSpecification> metricSpecifications)

      This structure includes the metrics and target utilization to use for predictive scaling.

      This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.

      Parameters:
      metricSpecifications - This structure includes the metrics and target utilization to use for predictive scaling.

      This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.

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

    • metricSpecifications

      PredictiveScalingPolicyConfiguration.Builder metricSpecifications(PredictiveScalingMetricSpecification... metricSpecifications)

      This structure includes the metrics and target utilization to use for predictive scaling.

      This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.

      Parameters:
      metricSpecifications - This structure includes the metrics and target utilization to use for predictive scaling.

      This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.

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

    • metricSpecifications

      PredictiveScalingPolicyConfiguration.Builder metricSpecifications(Consumer<PredictiveScalingMetricSpecification.Builder>... metricSpecifications)

      This structure includes the metrics and target utilization to use for predictive scaling.

      This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metricSpecifications(List<PredictiveScalingMetricSpecification>).

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

    • mode

      PredictiveScalingPolicyConfiguration.Builder mode(String mode)

      The predictive scaling mode. Defaults to ForecastOnly if not specified.

      Parameters:
      mode - The predictive scaling mode. Defaults to ForecastOnly if not specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mode

      PredictiveScalingPolicyConfiguration.Builder mode(PredictiveScalingMode mode)

      The predictive scaling mode. Defaults to ForecastOnly if not specified.

      Parameters:
      mode - The predictive scaling mode. Defaults to ForecastOnly if not specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • schedulingBufferTime

      PredictiveScalingPolicyConfiguration.Builder schedulingBufferTime(Integer schedulingBufferTime)

      The amount of time, in seconds, that the start time can be advanced.

      The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.

      Parameters:
      schedulingBufferTime - The amount of time, in seconds, that the start time can be advanced.

      The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.

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

    • maxCapacityBreachBehavior

      PredictiveScalingPolicyConfiguration.Builder maxCapacityBreachBehavior(String maxCapacityBreachBehavior)

      Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to HonorMaxCapacity if not specified.

      Parameters:
      maxCapacityBreachBehavior - Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to HonorMaxCapacity if not specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxCapacityBreachBehavior

      PredictiveScalingPolicyConfiguration.Builder maxCapacityBreachBehavior(PredictiveScalingMaxCapacityBreachBehavior maxCapacityBreachBehavior)

      Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to HonorMaxCapacity if not specified.

      Parameters:
      maxCapacityBreachBehavior - Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to HonorMaxCapacity if not specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxCapacityBuffer

      PredictiveScalingPolicyConfiguration.Builder maxCapacityBuffer(Integer maxCapacityBuffer)

      The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

      Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.

      Parameters:
      maxCapacityBuffer - The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

      Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.

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