software.amazon.awscdk.services.autoscaling

Interface CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnScalingPolicy

@Stability(value=Stable)
public static interface CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty
extends software.amazon.jsii.JsiiSerializable

A structure that specifies a metric specification for the `MetricSpecifications` property of the [AWS::AutoScaling::ScalingPolicy PredictiveScalingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html) property type.

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.autoscaling.*;
 PredictiveScalingMetricSpecificationProperty predictiveScalingMetricSpecificationProperty = PredictiveScalingMetricSpecificationProperty.builder()
         .targetValue(123)
         // the properties below are optional
         .customizedCapacityMetricSpecification(PredictiveScalingCustomizedCapacityMetricProperty.builder()
                 .metricDataQueries(List.of(MetricDataQueryProperty.builder()
                         .id("id")
                         // the properties below are optional
                         .expression("expression")
                         .label("label")
                         .metricStat(MetricStatProperty.builder()
                                 .metric(MetricProperty.builder()
                                         .metricName("metricName")
                                         .namespace("namespace")
                                         // the properties below are optional
                                         .dimensions(List.of(MetricDimensionProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .build())
                                 .stat("stat")
                                 // the properties below are optional
                                 .unit("unit")
                                 .build())
                         .returnData(false)
                         .build()))
                 .build())
         .customizedLoadMetricSpecification(PredictiveScalingCustomizedLoadMetricProperty.builder()
                 .metricDataQueries(List.of(MetricDataQueryProperty.builder()
                         .id("id")
                         // the properties below are optional
                         .expression("expression")
                         .label("label")
                         .metricStat(MetricStatProperty.builder()
                                 .metric(MetricProperty.builder()
                                         .metricName("metricName")
                                         .namespace("namespace")
                                         // the properties below are optional
                                         .dimensions(List.of(MetricDimensionProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .build())
                                 .stat("stat")
                                 // the properties below are optional
                                 .unit("unit")
                                 .build())
                         .returnData(false)
                         .build()))
                 .build())
         .customizedScalingMetricSpecification(PredictiveScalingCustomizedScalingMetricProperty.builder()
                 .metricDataQueries(List.of(MetricDataQueryProperty.builder()
                         .id("id")
                         // the properties below are optional
                         .expression("expression")
                         .label("label")
                         .metricStat(MetricStatProperty.builder()
                                 .metric(MetricProperty.builder()
                                         .metricName("metricName")
                                         .namespace("namespace")
                                         // the properties below are optional
                                         .dimensions(List.of(MetricDimensionProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .build())
                                 .stat("stat")
                                 // the properties below are optional
                                 .unit("unit")
                                 .build())
                         .returnData(false)
                         .build()))
                 .build())
         .predefinedLoadMetricSpecification(PredictiveScalingPredefinedLoadMetricProperty.builder()
                 .predefinedMetricType("predefinedMetricType")
                 // the properties below are optional
                 .resourceLabel("resourceLabel")
                 .build())
         .predefinedMetricPairSpecification(PredictiveScalingPredefinedMetricPairProperty.builder()
                 .predefinedMetricType("predefinedMetricType")
                 // the properties below are optional
                 .resourceLabel("resourceLabel")
                 .build())
         .predefinedScalingMetricSpecification(PredictiveScalingPredefinedScalingMetricProperty.builder()
                 .predefinedMetricType("predefinedMetricType")
                 // the properties below are optional
                 .resourceLabel("resourceLabel")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty.Builder A builder for CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty
static class	CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty.Jsii$Proxy An implementation for CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty

Method Summary

Modifier and Type	Method and Description
static CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty.Builder	builder()
default Object	getCustomizedCapacityMetricSpecification() The customized capacity metric specification.
default Object	getCustomizedLoadMetricSpecification() The customized load metric specification.
default Object	getCustomizedScalingMetricSpecification() The customized scaling metric specification.
default Object	getPredefinedLoadMetricSpecification() The predefined load metric specification.
default Object	getPredefinedMetricPairSpecification() The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
default Object	getPredefinedScalingMetricSpecification() The predefined scaling metric specification.
Number	getTargetValue() Specifies the target utilization.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTargetValue

@Stability(value=Stable)
 @NotNull
Number getTargetValue()

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.

getCustomizedCapacityMetricSpecification

@Stability(value=Stable)
 @Nullable
default Object getCustomizedCapacityMetricSpecification()

The customized capacity metric specification.

getCustomizedLoadMetricSpecification

@Stability(value=Stable)
 @Nullable
default Object getCustomizedLoadMetricSpecification()

The customized load metric specification.

getCustomizedScalingMetricSpecification

@Stability(value=Stable)
 @Nullable
default Object getCustomizedScalingMetricSpecification()

The customized scaling metric specification.

getPredefinedLoadMetricSpecification

@Stability(value=Stable)
 @Nullable
default Object getPredefinedLoadMetricSpecification()

The predefined load metric specification.

getPredefinedMetricPairSpecification

@Stability(value=Stable)
 @Nullable
default Object getPredefinedMetricPairSpecification()

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

getPredefinedScalingMetricSpecification

@Stability(value=Stable)
 @Nullable
default Object getPredefinedScalingMetricSpecification()

The predefined scaling metric specification.

builder

@Stability(value=Stable)
static CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty.Builder builder()

Returns:

a CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty.Builder of CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty