public static interface CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty
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
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.RequestCount
and RequestCountPerTarget
metrics, respectively.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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty.Builder
|
static class |
CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty.Jsii$Proxy
An implementation for
CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty |
Modifier and Type | Method and Description |
---|---|
static CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty.Builder |
builder() |
default java.lang.Object |
getCustomizedCapacityMetricSpecification()
The customized capacity metric specification.
|
default java.lang.Object |
getCustomizedLoadMetricSpecification()
The customized load metric specification.
|
default java.lang.Object |
getCustomizedScalingMetricSpecification()
The customized scaling metric specification.
|
default java.lang.Object |
getPredefinedLoadMetricSpecification()
The predefined load metric specification.
|
default java.lang.Object |
getPredefinedMetricPairSpecification()
The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
|
default java.lang.Object |
getPredefinedScalingMetricSpecification()
The predefined scaling metric specification.
|
java.lang.Number |
getTargetValue()
Specifies the target utilization.
|
java.lang.Number getTargetValue()
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.
default java.lang.Object getCustomizedCapacityMetricSpecification()
default java.lang.Object getCustomizedLoadMetricSpecification()
default java.lang.Object getCustomizedScalingMetricSpecification()
default java.lang.Object getPredefinedLoadMetricSpecification()
default java.lang.Object getPredefinedMetricPairSpecification()
default java.lang.Object getPredefinedScalingMetricSpecification()