Package software.amazon.awscdk.services.cloudwatch

Class MathExpressionProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • expression

      @Stability(Stable) public MathExpressionProps.Builder expression(String expression)
      Sets the value of MathExpressionProps.getExpression()
      Parameters:
      expression - The expression defining the metric. This parameter is required. When an expression contains a SEARCH function, it cannot be used within an Alarm.
      Returns:
      this

    • usingMetrics

      @Stability(Stable) public MathExpressionProps.Builder usingMetrics(Map<String,? extends IMetric> usingMetrics)
      Sets the value of MathExpressionProps.getUsingMetrics()
      Parameters:
      usingMetrics - The metrics used in the expression, in a map. The key is the identifier that represents the given metric in the expression, and the value is the actual Metric object.
      Returns:
      this

    • color

      @Stability(Stable) public MathExpressionProps.Builder color(String color)
      Sets the value of MathExpressionOptions.getColor()
      Parameters:
      color - Color for this metric when added to a Graph in a Dashboard.
      Returns:
      this

    • label

      @Stability(Stable) public MathExpressionProps.Builder label(String label)
      Sets the value of MathExpressionOptions.getLabel()
      Parameters:
      label - Label for this expression when added to a Graph in a Dashboard. If this expression evaluates to more than one time series (for example, through the use of METRICS() or SEARCH() expressions), each time series will appear in the graph using a combination of the expression label and the individual metric label. Specify the empty string ('') to suppress the expression label and only keep the metric label.

      You can use dynamic labels to show summary information about the displayed time series in the legend. For example, if you use: 

                    [max: ${MAX}] MyMetric

      As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. If the math expression produces more than one time series, the maximum will be shown for each individual time series produce by this math expression.

      Returns:
      this

    • period

      @Stability(Stable) public MathExpressionProps.Builder period(Duration period)
      Sets the value of MathExpressionOptions.getPeriod()
      Parameters:
      period - The period over which the expression's statistics are applied. This period overrides all periods in the metrics used in this math expression.
      Returns:
      this

    • searchAccount

      @Stability(Stable) public MathExpressionProps.Builder searchAccount(String searchAccount)
      Sets the value of MathExpressionOptions.getSearchAccount()
      Parameters:
      searchAccount - Account to evaluate search expressions within. Specifying a searchAccount has no effect to the account used for metrics within the expression (passed via usingMetrics).
      Returns:
      this

    • searchRegion

      @Stability(Stable) public MathExpressionProps.Builder searchRegion(String searchRegion)
      Sets the value of MathExpressionOptions.getSearchRegion()
      Parameters:
      searchRegion - Region to evaluate search expressions within. Specifying a searchRegion has no effect to the region used for metrics within the expression (passed via usingMetrics).
      Returns:
      this

    • build

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