PredictiveScalingMetricSpecification (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.autoscaling.model.PredictiveScalingMetricSpecification

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PredictiveScalingMetricSpecification
extends Object
implements Serializable, Cloneable
```
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.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PredictiveScalingMetricSpecification()

Constructors
Constructor and Description
`PredictiveScalingMetricSpecification()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PredictiveScalingMetricSpecification`	`clone()`
`boolean`	`equals(Object obj)`
`PredictiveScalingPredefinedLoadMetric`	`getPredefinedLoadMetricSpecification()` The load metric specification.
`PredictiveScalingPredefinedMetricPair`	`getPredefinedMetricPairSpecification()` The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
`PredictiveScalingPredefinedScalingMetric`	`getPredefinedScalingMetricSpecification()` The scaling metric specification.
`Double`	`getTargetValue()` Specifies the target utilization.
`int`	`hashCode()`
`void`	`setPredefinedLoadMetricSpecification(PredictiveScalingPredefinedLoadMetric predefinedLoadMetricSpecification)` The load metric specification.
`void`	`setPredefinedMetricPairSpecification(PredictiveScalingPredefinedMetricPair predefinedMetricPairSpecification)` The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
`void`	`setPredefinedScalingMetricSpecification(PredictiveScalingPredefinedScalingMetric predefinedScalingMetricSpecification)` The scaling metric specification.
`void`	`setTargetValue(Double targetValue)` Specifies the target utilization.
`String`	`toString()` Returns a string representation of this object.
`PredictiveScalingMetricSpecification`	`withPredefinedLoadMetricSpecification(PredictiveScalingPredefinedLoadMetric predefinedLoadMetricSpecification)` The load metric specification.
`PredictiveScalingMetricSpecification`	`withPredefinedMetricPairSpecification(PredictiveScalingPredefinedMetricPair predefinedMetricPairSpecification)` The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
`PredictiveScalingMetricSpecification`	`withPredefinedScalingMetricSpecification(PredictiveScalingPredefinedScalingMetric predefinedScalingMetricSpecification)` The scaling metric specification.
`PredictiveScalingMetricSpecification`	`withTargetValue(Double targetValue)` Specifies the target utilization.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PredictiveScalingMetricSpecification
```
public PredictiveScalingMetricSpecification()
```
- Method Detail
  - setTargetValue
```
public void setTargetValue(Double targetValue)
```
    Specifies the target utilization.
    
    Parameters:
    
    targetValue - Specifies the target utilization.
  - getTargetValue
```
public Double getTargetValue()
```
    Specifies the target utilization.
    
    Returns:
    
    Specifies the target utilization.
  - withTargetValue
```
public PredictiveScalingMetricSpecification withTargetValue(Double targetValue)
```
    Specifies the target utilization.
    
    Parameters:
    
    targetValue - Specifies the target utilization.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPredefinedMetricPairSpecification
```
public void setPredefinedMetricPairSpecification(PredictiveScalingPredefinedMetricPair predefinedMetricPairSpecification)
```
    The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
    
    Parameters:
    
    predefinedMetricPairSpecification - The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
  - getPredefinedMetricPairSpecification
```
public PredictiveScalingPredefinedMetricPair getPredefinedMetricPairSpecification()
```
    The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
    
    Returns:
    
    The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
  - withPredefinedMetricPairSpecification
```
public PredictiveScalingMetricSpecification withPredefinedMetricPairSpecification(PredictiveScalingPredefinedMetricPair predefinedMetricPairSpecification)
```
    The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
    
    Parameters:
    
    predefinedMetricPairSpecification - The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPredefinedScalingMetricSpecification
```
public void setPredefinedScalingMetricSpecification(PredictiveScalingPredefinedScalingMetric predefinedScalingMetricSpecification)
```
    The scaling metric specification.
    
    Parameters:
    
    predefinedScalingMetricSpecification - The scaling metric specification.
  - getPredefinedScalingMetricSpecification
```
public PredictiveScalingPredefinedScalingMetric getPredefinedScalingMetricSpecification()
```
    The scaling metric specification.
    
    Returns:
    
    The scaling metric specification.
  - withPredefinedScalingMetricSpecification
```
public PredictiveScalingMetricSpecification withPredefinedScalingMetricSpecification(PredictiveScalingPredefinedScalingMetric predefinedScalingMetricSpecification)
```
    The scaling metric specification.
    
    Parameters:
    
    predefinedScalingMetricSpecification - The scaling metric specification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPredefinedLoadMetricSpecification
```
public void setPredefinedLoadMetricSpecification(PredictiveScalingPredefinedLoadMetric predefinedLoadMetricSpecification)
```
    The load metric specification.
    
    Parameters:
    
    predefinedLoadMetricSpecification - The load metric specification.
  - getPredefinedLoadMetricSpecification
```
public PredictiveScalingPredefinedLoadMetric getPredefinedLoadMetricSpecification()
```
    The load metric specification.
    
    Returns:
    
    The load metric specification.
  - withPredefinedLoadMetricSpecification
```
public PredictiveScalingMetricSpecification withPredefinedLoadMetricSpecification(PredictiveScalingPredefinedLoadMetric predefinedLoadMetricSpecification)
```
    The load metric specification.
    
    Parameters:
    
    predefinedLoadMetricSpecification - The load metric specification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PredictiveScalingMetricSpecification clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class PredictiveScalingMetricSpecification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PredictiveScalingMetricSpecification

Method Detail

setTargetValue

getTargetValue

withTargetValue

setPredefinedMetricPairSpecification

getPredefinedMetricPairSpecification

withPredefinedMetricPairSpecification

setPredefinedScalingMetricSpecification

getPredefinedScalingMetricSpecification

withPredefinedScalingMetricSpecification

setPredefinedLoadMetricSpecification

getPredefinedLoadMetricSpecification

withPredefinedLoadMetricSpecification

toString

equals

hashCode

clone