software.amazon.awscdk.services.cloudwatch

Interface CfnAlarm.MetricDataQueryProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlarm.MetricDataQueryProperty.Jsii$Proxy

Enclosing class:

CfnAlarm

@Stability(value=Stable)
public static interface CfnAlarm.MetricDataQueryProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.cloudwatch.*;
 MetricDataQueryProperty metricDataQueryProperty = MetricDataQueryProperty.builder()
         .id("id")
         // the properties below are optional
         .accountId("accountId")
         .expression("expression")
         .label("label")
         .metricStat(MetricStatProperty.builder()
                 .metric(MetricProperty.builder()
                         .dimensions(List.of(DimensionProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .metricName("metricName")
                         .namespace("namespace")
                         .build())
                 .period(123)
                 .stat("stat")
                 // the properties below are optional
                 .unit("unit")
                 .build())
         .period(123)
         .returnData(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAlarm.MetricDataQueryProperty.Builder A builder for CfnAlarm.MetricDataQueryProperty
static class	CfnAlarm.MetricDataQueryProperty.Jsii$Proxy An implementation for CfnAlarm.MetricDataQueryProperty

Method Summary

Modifier and Type	Method and Description
static CfnAlarm.MetricDataQueryProperty.Builder	builder()
default String	getAccountId() The ID of the account where the metrics are located, if this is a cross-account alarm.
default String	getExpression() The math expression to be performed on the returned data, if this object is performing a math expression.
String	getId() A short name used to tie this object to the results in the response.
default String	getLabel() A human-readable label for this metric or expression.
default Object	getMetricStat() The metric to be returned, along with statistics, period, and units.
default Number	getPeriod() The granularity, in seconds, of the returned data points.
default Object	getReturnData() This option indicates whether to return the timestamps and raw data values of this metric.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getId

@Stability(value=Stable)
 @NotNull
String getId()

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.

getAccountId

@Stability(value=Stable)
 @Nullable
default String getAccountId()

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

getExpression

@Stability(value=Stable)
 @Nullable
default String getExpression()

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.

getLabel

@Stability(value=Stable)
 @Nullable
default String getLabel()

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.

getMetricStat

@Stability(value=Stable)
 @Nullable
default Object getMetricStat()

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.

getPeriod

@Stability(value=Stable)
 @Nullable
default Number getPeriod()

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 .

getReturnData

@Stability(value=Stable)
 @Nullable
default Object getReturnData()

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.

builder

@Stability(value=Stable)
static CfnAlarm.MetricDataQueryProperty.Builder builder()

Returns:

a CfnAlarm.MetricDataQueryProperty.Builder of CfnAlarm.MetricDataQueryProperty