1.204.0

interface MetricDataQueryProperty

LanguageType name
.NETAmazon.CDK.AWS.CloudWatch.CfnAlarm.MetricDataQueryProperty
Javasoftware.amazon.awscdk.services.cloudwatch.CfnAlarm.MetricDataQueryProperty
Pythonaws_cdk.aws_cloudwatch.CfnAlarm.MetricDataQueryProperty
TypeScript @aws-cdk/aws-cloudwatch » 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.

Any expression used must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloudwatch from '@aws-cdk/aws-cloudwatch';
const metricDataQueryProperty: cloudwatch.CfnAlarm.MetricDataQueryProperty = {
  id: 'id',

  // the properties below are optional
  accountId: 'accountId',
  expression: 'expression',
  label: 'label',
  metricStat: {
    metric: {
      dimensions: [{
        name: 'name',
        value: 'value',
      }],
      metricName: 'metricName',
      namespace: 'namespace',
    },
    period: 123,
    stat: 'stat',

    // the properties below are optional
    unit: 'unit',
  },
  period: 123,
  returnData: false,
};

Properties

NameTypeDescription
idstringA short name used to tie this object to the results in the response.
accountId?stringThe ID of the account where the metrics are located, if this is a cross-account alarm.
expression?stringThe math expression to be performed on the returned data, if this object is performing a math expression.
label?stringA human-readable label for this metric or expression.
metricStat?IResolvable | MetricStatPropertyThe metric to be returned, along with statistics, period, and units.
period?numberThe granularity, in seconds, of the returned data points.
returnData?boolean | IResolvableThis option indicates whether to return the timestamps and raw data values of this metric.

id

Type: string

A short name used to tie this object to the results in the response.

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.

accountId?

Type: string (optional)

The ID of the account where the metrics are located, if this is a cross-account alarm.

expression?

Type: string (optional)

The math expression to be performed on the returned data, if this object is performing a math expression.

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.

label?

Type: string (optional)

A human-readable label for this metric or expression.

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?

Type: IResolvable | MetricStatProperty (optional)

The metric to be returned, along with statistics, period, and units.

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?

Type: number (optional)

The granularity, in seconds, of the returned data points.

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?

Type: boolean | IResolvable (optional)

This option indicates whether to return the timestamps and raw data values of this metric.

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.

← PreviousNext →