Package software.amazon.awscdk.services.cloudwatch

Class SearchExpressionProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • expression

      @Stability(Stable) public SearchExpressionProps.Builder expression(String expression)
      Sets the value of SearchExpressionProps.getExpression()
      Parameters:
      expression - The search expression defining the metrics to be retrieved. This parameter is required. A search expression cannot be used within an Alarm.

      A search expression allows you to retrieve and graph multiple related metrics in a single statement. It can return up to 500 time series.

      Examples:

      • SEARCH('{AWS/EC2,InstanceId} CPUUtilization', 'Average', 300)
      • SEARCH('{AWS/ApplicationELB,LoadBalancer} RequestCount', 'Sum', 60)
      • SEARCH('{MyNamespace,ServiceName} Errors', 'Sum')

      For more information about search expression syntax, see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/search-expression-syntax.html

      Returns:
      this

    • color

      @Stability(Stable) public SearchExpressionProps.Builder color(String color)
      Sets the value of SearchExpressionOptions.getColor()
      Parameters:
      color - Color for the metric produced by the search expression. If the search expression produces more than one time series, the color is assigned to the first one. Other metrics are assigned colors automatically.
      Returns:
      this

    • label

      @Stability(Stable) public SearchExpressionProps.Builder label(String label)
      Sets the value of SearchExpressionOptions.getLabel()
      Parameters:
      label - Label for this search expression when added to a Graph in a Dashboard. If this expression evaluates to more than one time series, 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 search expression produces more than one time series, the maximum will be shown for each individual time series produce by this search expression.

      Returns:
      this

    • period

      @Stability(Stable) public SearchExpressionProps.Builder period(Duration period)
      Sets the value of SearchExpressionOptions.getPeriod()
      Parameters:
      period - The period over which the search expression's statistics are applied. This period overrides the period defined within the search expression.
      Returns:
      this

    • searchAccount

      @Stability(Stable) public SearchExpressionProps.Builder searchAccount(String searchAccount)
      Sets the value of SearchExpressionOptions.getSearchAccount()
      Parameters:
      searchAccount - Account to evaluate search expressions within.
      Returns:
      this

    • searchRegion

      @Stability(Stable) public SearchExpressionProps.Builder searchRegion(String searchRegion)
      Sets the value of SearchExpressionOptions.getSearchRegion()
      Parameters:
      searchRegion - Region to evaluate search expressions within.
      Returns:
      this

    • build

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