Package software.amazon.awscdk.services.cloudwatch

Class CfnAlarm.MetricDataQueryProperty.Builder

java.lang.Object
software.amazon.awscdk.services.cloudwatch.CfnAlarm.MetricDataQueryProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAlarm.MetricDataQueryProperty>
Enclosing interface:
CfnAlarm.MetricDataQueryProperty
@Stability(Stable) public static final class CfnAlarm.MetricDataQueryProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnAlarm.MetricDataQueryProperty>
A builder for CfnAlarm.MetricDataQueryProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • id

      @Stability(Stable) public CfnAlarm.MetricDataQueryProperty.Builder id(String id)
      Sets the value of CfnAlarm.MetricDataQueryProperty.getId()
      Parameters:
      id - A short name used to tie this object to the results in the response. This parameter is required. 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.
      Returns:
      this

    • accountId

      @Stability(Stable) public CfnAlarm.MetricDataQueryProperty.Builder accountId(String accountId)
      Sets the value of CfnAlarm.MetricDataQueryProperty.getAccountId()
      Parameters:
      accountId - The ID of the account where the metrics are located, if this is a cross-account alarm.
      Returns:
      this

    • expression

      @Stability(Stable) public CfnAlarm.MetricDataQueryProperty.Builder expression(String expression)
      Sets the value of CfnAlarm.MetricDataQueryProperty.getExpression()
      Parameters:
      expression - 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.

      Returns:
      this

    • label

      @Stability(Stable) public CfnAlarm.MetricDataQueryProperty.Builder label(String label)
      Sets the value of CfnAlarm.MetricDataQueryProperty.getLabel()
      Parameters:
      label - 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.
      Returns:
      this

    • metricStat

      @Stability(Stable) public CfnAlarm.MetricDataQueryProperty.Builder metricStat(IResolvable metricStat)
      Sets the value of CfnAlarm.MetricDataQueryProperty.getMetricStat()
      Parameters:
      metricStat - 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.

      Returns:
      this

    • metricStat

      @Stability(Stable) public CfnAlarm.MetricDataQueryProperty.Builder metricStat(CfnAlarm.MetricStatProperty metricStat)
      Sets the value of CfnAlarm.MetricDataQueryProperty.getMetricStat()
      Parameters:
      metricStat - 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.

      Returns:
      this

    • period

      @Stability(Stable) public CfnAlarm.MetricDataQueryProperty.Builder period(Number period)
      Sets the value of CfnAlarm.MetricDataQueryProperty.getPeriod()
      Parameters:
      period - 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 .
      Returns:
      this

    • returnData

      @Stability(Stable) public CfnAlarm.MetricDataQueryProperty.Builder returnData(Boolean returnData)
      Sets the value of CfnAlarm.MetricDataQueryProperty.getReturnData()
      Parameters:
      returnData - 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.

      Returns:
      this

    • returnData

      @Stability(Stable) public CfnAlarm.MetricDataQueryProperty.Builder returnData(IResolvable returnData)
      Sets the value of CfnAlarm.MetricDataQueryProperty.getReturnData()
      Parameters:
      returnData - 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.

      Returns:
      this

    • build

      @Stability(Stable) public CfnAlarm.MetricDataQueryProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnAlarm.MetricDataQueryProperty>
      Returns:
      a new instance of CfnAlarm.MetricDataQueryProperty
      Throws:
      NullPointerException - if any required attribute was not provided