AWS CloudFormation
User Guide (Version )

AWS::AutoScalingPlans::ScalingPlan CustomizedLoadMetricSpecification

CustomizedLoadMetricSpecification is a subproperty of ScalingInstruction that specifies a customized load metric for predictive scaling to use with AWS Auto Scaling.

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.

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Dimensions" : [ MetricDimension, ... ], "MetricName" : String, "Namespace" : String, "Statistic" : String, "Unit" : String }

YAML

Dimensions: - MetricDimension MetricName: String Namespace: String Statistic: String Unit: String

Properties

Dimensions

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification.

Required: No

Type: List of MetricDimension

Update requires: No interruption

MetricName

The name of the metric.

Required: Yes

Type: String

Update requires: No interruption

Namespace

The namespace of the metric.

Required: Yes

Type: String

Update requires: No interruption

Statistic

The statistic of the metric. Currently, the value must always be Sum.

Required: Yes

Type: String

Allowed Values: Average | Maximum | Minimum | SampleCount | Sum

Update requires: No interruption

Unit

The unit of the metric.

Required: No

Type: String

Update requires: No interruption

See Also

On this page: