CustomizedMetricSpecification - Amazon EC2 Auto Scaling
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

CustomizedMetricSpecification

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

To create your customized 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 more information about the CloudWatch terminology below, see Amazon CloudWatch concepts.

Note

Each individual service provides information about the metrics, namespace, and dimensions they use. For more information, see Amazon services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.

Contents

Dimensions.member.N

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

Type: Array of MetricDimension objects

Required: No

MetricName

The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

Type: String

Required: No

Metrics.member.N

The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

Type: Array of TargetTrackingMetricDataQuery objects

Required: No

Namespace

The namespace of the metric.

Type: String

Required: No

Statistic

The statistic of the metric.

Type: String

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

Required: No

Unit

The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: