Package software.amazon.awscdk.services.cloudwatch

Class CfnAlarm.MetricDataQueryProperty.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.cloudwatch.CfnAlarm.MetricDataQueryProperty.Jsii$Proxy
All Implemented Interfaces:
CfnAlarm.MetricDataQueryProperty, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnAlarm.MetricDataQueryProperty
@Stability(Stable) @Internal public static final class CfnAlarm.MetricDataQueryProperty.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnAlarm.MetricDataQueryProperty
An implementation for CfnAlarm.MetricDataQueryProperty

  • Constructor Details

    • 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(CfnAlarm.MetricDataQueryProperty.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnAlarm.MetricDataQueryProperty.Builder.

  • Method Details

    • getId

      public final String getId()
      Description copied from interface: CfnAlarm.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 CfnAlarm.MetricDataQueryProperty

    • getAccountId

      public final String getAccountId()
      Description copied from interface: CfnAlarm.MetricDataQueryProperty
      The ID of the account where the metrics are located, if this is a cross-account alarm.
      Specified by:
      getAccountId in interface CfnAlarm.MetricDataQueryProperty

    • getExpression

      public final String getExpression()
      Description copied from interface: CfnAlarm.MetricDataQueryProperty
      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.

      Specified by:
      getExpression in interface CfnAlarm.MetricDataQueryProperty

    • getLabel

      public final String getLabel()
      Description copied from interface: CfnAlarm.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.

      Specified by:
      getLabel in interface CfnAlarm.MetricDataQueryProperty

    • getMetricStat

      public final Object getMetricStat()
      Description copied from interface: CfnAlarm.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 CfnAlarm.MetricDataQueryProperty

    • getPeriod

      public final Number getPeriod()
      Description copied from interface: CfnAlarm.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 CfnAlarm.MetricDataQueryProperty

    • getReturnData

      public final Object getReturnData()
      Description copied from interface: CfnAlarm.MetricDataQueryProperty
      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.

      Specified by:
      getReturnData in interface CfnAlarm.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