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

Class PredictiveScalingMetricSpecification

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

This structure specifies the metrics and target utilization settings for a predictive scaling policy.

You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.

Example

  • You create a predictive scaling policy and specify ALBRequestCount as the value for the metric pair and 1000.0 as the target value. For this type of metric, you must provide the metric dimension for the corresponding target group, so you also provide a resource label for the Application Load Balancer target group that is attached to your Auto Scaling group.

  • The number of requests the target group receives per minute provides the load metric, and the request count averaged between the members of the target group provides the scaling metric. In CloudWatch, this refers to the RequestCount and RequestCountPerTarget metrics, respectively.

  • For optimal use of predictive scaling, you adhere to the best practice of using a dynamic scaling policy to automatically scale between the minimum capacity and maximum capacity in response to real-time changes in resource utilization.

  • Amazon EC2 Auto Scaling consumes data points for the load metric over the last 14 days and creates an hourly load forecast for predictive scaling. (A minimum of 24 hours of data is required.)

  • After creating the load forecast, Amazon EC2 Auto Scaling determines when to reduce or increase the capacity of your Auto Scaling group in each hour of the forecast period so that the average number of requests received by each instance is as close to 1000 requests per minute as possible at all times.

For information about using custom metrics with predictive scaling, see Advanced predictive scaling policy configurations using custom metrics in the Amazon EC2 Auto Scaling User Guide.

See Also:

  • Method Details

    • targetValue

      public final Double targetValue()

      Specifies the target utilization.

      Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.

      Returns:
      Specifies the target utilization.

      Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.

    • predefinedMetricPairSpecification

      public final PredictiveScalingPredefinedMetricPair predefinedMetricPairSpecification()

      The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.

      Returns:
      The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.

    • predefinedScalingMetricSpecification

      public final PredictiveScalingPredefinedScalingMetric predefinedScalingMetricSpecification()

      The predefined scaling metric specification.

      Returns:
      The predefined scaling metric specification.

    • predefinedLoadMetricSpecification

      public final PredictiveScalingPredefinedLoadMetric predefinedLoadMetricSpecification()

      The predefined load metric specification.

      Returns:
      The predefined load metric specification.

    • customizedScalingMetricSpecification

      public final PredictiveScalingCustomizedScalingMetric customizedScalingMetricSpecification()

      The customized scaling metric specification.

      Returns:
      The customized scaling metric specification.

    • customizedLoadMetricSpecification

      public final PredictiveScalingCustomizedLoadMetric customizedLoadMetricSpecification()

      The customized load metric specification.

      Returns:
      The customized load metric specification.

    • customizedCapacityMetricSpecification

      public final PredictiveScalingCustomizedCapacityMetric customizedCapacityMetricSpecification()

      The customized capacity metric specification.

      Returns:
      The customized capacity metric specification.

    • toBuilder

      public PredictiveScalingMetricSpecification.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<PredictiveScalingMetricSpecification.Builder,PredictiveScalingMetricSpecification>
      Returns:
      a builder for type T

    • builder

      public static PredictiveScalingMetricSpecification.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PredictiveScalingMetricSpecification.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.