Class CfnAlarm.MetricDataQueryProperty
The MetricDataQuery property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.AWS.CloudWatch.dll
Syntax (csharp)
public class MetricDataQueryProperty : Object, CfnAlarm.IMetricDataQueryPropertySyntax (vb)
Public Class MetricDataQueryProperty
Inherits Object
Implements CfnAlarm.IMetricDataQueryPropertyRemarks
Any expression used must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudWatch;
MetricDataQueryProperty metricDataQueryProperty = new MetricDataQueryProperty {
Id = "id",
// the properties below are optional
AccountId = "accountId",
Expression = "expression",
Label = "label",
MetricStat = new MetricStatProperty {
Metric = new MetricProperty {
Dimensions = new [] { new DimensionProperty {
Name = "name",
Value = "value"
} },
MetricName = "metricName",
Namespace = "namespace"
},
Period = 123,
Stat = "stat",
// the properties below are optional
Unit = "unit"
},
Period = 123,
ReturnData = false
};Synopsis
Constructors
| MetricDataQueryProperty() |
Properties
| AccountId | The ID of the account where the metrics are located, if this is a cross-account alarm. |
| Expression | The math expression to be performed on the returned data, if this object is performing a math expression. |
| Id | A short name used to tie this object to the results in the response. |
| Label | A human-readable label for this metric or expression. |
| MetricStat | The metric to be returned, along with statistics, period, and units. |
| Period | The granularity, in seconds, of the returned data points. |
| ReturnData | This option indicates whether to return the timestamps and raw data values of this metric. |
Constructors
MetricDataQueryProperty()
public MetricDataQueryProperty()Properties
AccountId
The ID of the account where the metrics are located, if this is a cross-account alarm.
public string AccountId { get; set; }Property Value
System.String
Remarks
Expression
The math expression to be performed on the returned data, if this object is performing a math expression.
public string Expression { get; set; }Property Value
System.String
Remarks
This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id
A short name used to tie this object to the results in the response.
public string Id { get; set; }Property Value
System.String
Remarks
This name must be unique within a single call to GetMetricData . If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
Label
A human-readable label for this metric or expression.
public string Label { get; set; }Property Value
System.String
Remarks
This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.
MetricStat
The metric to be returned, along with statistics, period, and units.
public object MetricStat { get; set; }Property Value
System.Object
Remarks
Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Period
The granularity, in seconds, of the returned data points.
public Nullable<double> Period { get; set; }Property Value
System.Nullable<System.Double>
Remarks
For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second .
ReturnData
This option indicates whether to return the timestamps and raw data values of this metric.
public object ReturnData { get; set; }Property Value
System.Object
Remarks
When you create an alarm based on a metric math expression, specify True for this value for only the one math expression that the alarm is based on. You must specify False for ReturnData for all the other metrics and expressions used in the alarm.
This field is required.