AWS CloudFormation
User Guide (Version )

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

AWS::AutoScalingPlans::ScalingPlan CustomizedScalingMetricSpecification

CustomizedScalingMetricSpecification is a subproperty of TargetTrackingConfiguration that specifies a customized scaling metric for a target tracking configuration to use with AWS Auto Scaling.

To create your customized scaling metric specification:

  • Add values for each required property from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.

  • Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.

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 scaling 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.

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: