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.

For more information, see Predictive scaling 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 load metric specification.
default Object	getPredefinedMetricPairSpecification() The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
default Object	getPredefinedScalingMetricSpecification() The 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 load metric specification.

If you specify PredefinedMetricPairSpecification , don't specify this property.

getPredefinedMetricPairSpecification

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

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

With predictive scaling, 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.

getPredefinedScalingMetricSpecification

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

The scaling metric specification.

If you specify PredefinedMetricPairSpecification , don't specify this property.

builder

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

Returns:

a CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty.Builder of CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty