software.amazon.awscdk.services.cloudwatch

Class CfnAnomalyDetector.MetricDataQueryProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cloudwatch.CfnAnomalyDetector.MetricDataQueryProperty.Jsii$Proxy

All Implemented Interfaces:

CfnAnomalyDetector.MetricDataQueryProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnAnomalyDetector.MetricDataQueryProperty

@Stability(value=Stable)
 @Internal
public static final class CfnAnomalyDetector.MetricDataQueryProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnAnomalyDetector.MetricDataQueryProperty

An implementation for CfnAnomalyDetector.MetricDataQueryProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudwatch.CfnAnomalyDetector.MetricDataQueryProperty

CfnAnomalyDetector.MetricDataQueryProperty.Builder, CfnAnomalyDetector.MetricDataQueryProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(CfnAnomalyDetector.MetricDataQueryProperty.Builder builder) Constructor that initializes the object based on literal property values passed by the CfnAnomalyDetector.ConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getAccountId() The ID of the account where the metrics are located, if this is a cross-account alarm.
String	getExpression() This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data.
String	getId() A short name used to tie this object to the results in the response.
String	getLabel() A human-readable label for this metric or expression.
Object	getMetricStat() The metric to be returned, along with statistics, period, and units.
Number	getPeriod() The granularity, in seconds, of the returned data points.
Object	getReturnData() When used in `GetMetricData` , this option indicates whether to return the timestamps and raw data values of this metric.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.cloudwatch.CfnAnomalyDetector.MetricDataQueryProperty

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnAnomalyDetector.MetricDataQueryProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnAnomalyDetector.ConfigurationProperty.Builder.

Method Detail

getId

public final String getId()

Description copied from interface: CfnAnomalyDetector.MetricDataQueryProperty

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.

Specified by:

getId in interface CfnAnomalyDetector.MetricDataQueryProperty

getAccountId

public final String getAccountId()

Description copied from interface: CfnAnomalyDetector.MetricDataQueryProperty

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

Use this field only for PutMetricAlarm operations. It is not used in GetMetricData operations.

Specified by:

getAccountId in interface CfnAnomalyDetector.MetricDataQueryProperty

getExpression

public final String getExpression()

Description copied from interface: CfnAnomalyDetector.MetricDataQueryProperty

This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data.

For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .

A math expression can use the Id of the other metrics or queries 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.

Specified by:

getExpression in interface CfnAnomalyDetector.MetricDataQueryProperty

getLabel

public final String getLabel()

Description copied from interface: CfnAnomalyDetector.MetricDataQueryProperty

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.

You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels .

Specified by:

getLabel in interface CfnAnomalyDetector.MetricDataQueryProperty

getMetricStat

public final Object getMetricStat()

Description copied from interface: CfnAnomalyDetector.MetricDataQueryProperty

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.

Specified by:

getMetricStat in interface CfnAnomalyDetector.MetricDataQueryProperty

getPeriod

public final Number getPeriod()

Description copied from interface: CfnAnomalyDetector.MetricDataQueryProperty

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 .

Specified by:

getPeriod in interface CfnAnomalyDetector.MetricDataQueryProperty

getReturnData

public final Object getReturnData()

Description copied from interface: CfnAnomalyDetector.MetricDataQueryProperty

When used in `GetMetricData` , this option indicates whether to return the timestamps and raw data values of this metric.

If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False . If you omit this, the default of True is used.

When used in PutMetricAlarm , specify True for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

Specified by:

getReturnData in interface CfnAnomalyDetector.MetricDataQueryProperty

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object