Package software.amazon.awssdk.services.autoscaling.model

Class PredictiveScalingConfiguration

java.lang.Object
software.amazon.awssdk.services.autoscaling.model.PredictiveScalingConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PredictiveScalingConfiguration.Builder,PredictiveScalingConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class PredictiveScalingConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PredictiveScalingConfiguration.Builder,PredictiveScalingConfiguration>

Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling.

See Also:

  • Method Details

    • hasMetricSpecifications

      public final boolean hasMetricSpecifications()
      For responses, this returns true if the service returned a value for the MetricSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • metricSpecifications

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricSpecifications() method.

      Returns:
      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.

    • mode

      public final PredictiveScalingMode mode()

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

      If the service returns an enum value that is not available in the current SDK version, mode will return PredictiveScalingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

      Returns:
      The predictive scaling mode. Defaults to ForecastOnly if not specified.
      See Also:

    • modeAsString

      public final String modeAsString()

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

      If the service returns an enum value that is not available in the current SDK version, mode will return PredictiveScalingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

      Returns:
      The predictive scaling mode. Defaults to ForecastOnly if not specified.
      See Also:

    • schedulingBufferTime

      public final Integer schedulingBufferTime()

      The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

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

      Returns:
      The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

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

    • maxCapacityBreachBehavior

      public final PredictiveScalingMaxCapacityBreachBehavior maxCapacityBreachBehavior()

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

      The following are possible values:

      • HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

      • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

      If the service returns an enum value that is not available in the current SDK version, maxCapacityBreachBehavior will return PredictiveScalingMaxCapacityBreachBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maxCapacityBreachBehaviorAsString().

      Returns:
      Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.

      The following are possible values:

      • HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

      • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

      See Also:

    • maxCapacityBreachBehaviorAsString

      public final String maxCapacityBreachBehaviorAsString()

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

      The following are possible values:

      • HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

      • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

      If the service returns an enum value that is not available in the current SDK version, maxCapacityBreachBehavior will return PredictiveScalingMaxCapacityBreachBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maxCapacityBreachBehaviorAsString().

      Returns:
      Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.

      The following are possible values:

      • HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

      • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

      See Also:

    • maxCapacityBuffer

      public final 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.

      If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

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

      Returns:
      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.

      If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

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

    • toBuilder

      public PredictiveScalingConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PredictiveScalingConfiguration.Builder,PredictiveScalingConfiguration>
      Returns:
      a builder for type T

    • builder

      public static PredictiveScalingConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PredictiveScalingConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.