CustomizedScalingMetricSpecification
Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with a scaling plan.
To create your customized scaling metric specification:
-
Add values for each required parameter 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 Publishing 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, and increase when capacity decreases.
For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts in the Amazon CloudWatch User Guide.
Contents
- MetricName
-
The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metrics object that is returned by a call to ListMetrics.
Type: String
Required: Yes
- Namespace
-
The namespace of the metric.
Type: String
Required: Yes
- Statistic
-
The statistic of the metric.
Type: String
Valid Values:
Average | Minimum | Maximum | SampleCount | SumRequired: Yes
- Dimensions
-
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
- 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: