Package software.amazon.awscdk.services.cloudwatch

Interface SearchExpressionOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

SearchExpressionProps

All Known Implementing Classes:

SearchExpressionOptions.Jsii$Proxy, SearchExpressionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-07-24T11:33:10.797Z")
@Stability(Stable)
public interface SearchExpressionOptions
extends software.amazon.jsii.JsiiSerializable

Configurable options for SearchExpressions.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.cloudwatch.*;
 SearchExpressionOptions searchExpressionOptions = SearchExpressionOptions.builder()
         .color("color")
         .label("label")
         .period(Duration.minutes(30))
         .searchAccount("searchAccount")
         .searchRegion("searchRegion")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SearchExpressionOptions.Builder	A builder for SearchExpressionOptions
static final class	SearchExpressionOptions.Jsii$Proxy	An implementation for SearchExpressionOptions

Method Summary

Modifier and Type	Method	Description
static SearchExpressionOptions.Builder	builder()
default String	getColor()	Color for the metric produced by the search expression.
default String	getLabel()	Label for this search expression when added to a Graph in a Dashboard.
default Duration	getPeriod()	The period over which the search expression's statistics are applied.
default String	getSearchAccount()	Account to evaluate search expressions within.
default String	getSearchRegion()	Region to evaluate search expressions within.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColor

@Stability(Stable)
@Nullable
default String getColor()

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.

getLabel

@Stability(Stable)
@Nullable
default String getLabel()

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.

getPeriod

@Stability(Stable)
@Nullable
default Duration getPeriod()

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)

getSearchAccount

@Stability(Stable)
@Nullable
default String getSearchAccount()

Account to evaluate search expressions within.

Default: - Deployment account.

getSearchRegion

@Stability(Stable)
@Nullable
default String getSearchRegion()

Region to evaluate search expressions within.

Default: - Deployment region.

builder

@Stability(Stable)
static SearchExpressionOptions.Builder builder()

Returns:

a SearchExpressionOptions.Builder of SearchExpressionOptions