Package software.amazon.awscdk.services.cloudwatch

Class SearchExpression.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static SearchExpression.Builder create()
      Returns:
      a new instance of SearchExpression.Builder.

    • color

      @Stability(Stable) public SearchExpression.Builder color(String 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.

      Default: - Automatically assigned.

      Parameters:
      color - Color for the metric produced by the search expression. This parameter is required.
      Returns:
      this

    • label

      @Stability(Stable) public SearchExpression.Builder label(String 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.

      Default: - No label.

      Parameters:
      label - Label for this search expression when added to a Graph in a Dashboard. This parameter is required.
      Returns:
      this

    • period

      @Stability(Stable) public SearchExpression.Builder period(Duration period)
      The period over which the search expression's statistics are applied.

      This period overrides the period defined within the search expression.

      Default: Duration.minutes(5)

      Parameters:
      period - The period over which the search expression's statistics are applied. This parameter is required.
      Returns:
      this

    • searchAccount

      @Stability(Stable) public SearchExpression.Builder searchAccount(String searchAccount)
      Account to evaluate search expressions within.

      Default: - Deployment account.

      Parameters:
      searchAccount - Account to evaluate search expressions within. This parameter is required.
      Returns:
      this

    • searchRegion

      @Stability(Stable) public SearchExpression.Builder searchRegion(String searchRegion)
      Region to evaluate search expressions within.

      Default: - Deployment region.

      Parameters:
      searchRegion - Region to evaluate search expressions within. This parameter is required.
      Returns:
      this

    • expression

      @Stability(Stable) public SearchExpression.Builder expression(String expression)
      The search expression defining the metrics to be retrieved.

      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

      Parameters:
      expression - The search expression defining the metrics to be retrieved. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public SearchExpression build()
      Specified by:
      build in interface software.amazon.jsii.Builder<SearchExpression>
      Returns:
      a newly built instance of SearchExpression.