Package software.amazon.awscdk.services.autoscalingplans

Interface CfnScalingPlan.CustomizedLoadMetricSpecificationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnScalingPlan.CustomizedLoadMetricSpecificationProperty.Jsii$Proxy
Enclosing class:
CfnScalingPlan
@Stability(Stable) public static interface CfnScalingPlan.CustomizedLoadMetricSpecificationProperty extends software.amazon.jsii.JsiiSerializable
CustomizedLoadMetricSpecification is a subproperty of ScalingInstruction that specifies a customized load metric for predictive scaling to use with AWS Auto Scaling ( Auto Scaling Plans ).

For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch computes from metric data.

When you choose a load metric, make sure that the required Sum and Average statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum statistic must represent the total load on the resource, and the Average statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum statistic represents the total request count processed by the group, then the Average statistic for the specified metric must represent the average request count processed by each instance of the group.

If you publish your own metrics, you can aggregate the data points at a given interval and then publish the aggregated data points to CloudWatch. Before AWS Auto Scaling generates the forecast, it sums up all the metric data points that occurred within each hour to match the granularity period that is used in the forecast (60 minutes).

For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide .

After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource in the AWS 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.autoscalingplans.*;
 CustomizedLoadMetricSpecificationProperty customizedLoadMetricSpecificationProperty = CustomizedLoadMetricSpecificationProperty.builder()
         .metricName("metricName")
         .namespace("namespace")
         .statistic("statistic")
         // the properties below are optional
         .dimensions(List.of(MetricDimensionProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .unit("unit")
         .build();