MetricStat
This structure defines the CloudWatch metric to return, along with the statistic and unit.
MetricStat
is a property of the MetricDataQuery object.
For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts in the Amazon CloudWatch User Guide.
Contents
- Metric
-
The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
Type: Metric object
Required: Yes
- Stat
-
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
The most commonly used metrics for predictive scaling are
Average
andSum
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes
- Unit
-
The unit to use for the returned data points. 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 AWS SDKs, see the following: