Skip to content
v2.278.0

SearchExpressionOptions Struct ​

Configurable options for SearchExpressions.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
const searchExpressionOptions: cloudwatch.SearchExpressionOptions = {
  color: 'color',
  label: 'label',
  period: cdk.Duration.minutes(30),
  searchAccount: 'searchAccount',
  searchRegion: 'searchRegion',
  visible: false,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_cloudwatch as cloudwatch

search_expression_options = cloudwatch.SearchExpressionOptions(
    color="color",
    label="label",
    period=cdk.Duration.minutes(30),
    search_account="searchAccount",
    search_region="searchRegion",
    visible=False
)
java
// 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")
        .visible(false)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.CloudWatch;

var searchExpressionOptions = new SearchExpressionOptions {
    Color = "color",
    Label = "label",
    Period = Duration.Minutes(30),
    SearchAccount = "searchAccount",
    SearchRegion = "searchRegion",
    Visible = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

searchExpressionOptions := &SearchExpressionOptions{
	Color: jsii.String("color"),
	Label: jsii.String("label"),
	Period: cdk.Duration_Minutes(jsii.Number(30)),
	SearchAccount: jsii.String("searchAccount"),
	SearchRegion: jsii.String("searchRegion"),
	Visible: jsii.Boolean(false),
}

Properties ​

coloroptionalstringcoloroptionalstrcoloroptionalStringColoroptionalstringColoroptional*string #
Color for the metric produced by the search expression.

Default: Automatically assigned.

If the search expression produces more than one time series, the color is assigned to the first one. Other metrics are assigned colors automatically.

labeloptionalstringlabeloptionalstrlabeloptionalStringLabeloptionalstringLabeloptional*string #
Label for this search expression when added to a Graph in a Dashboard.

Default: No label.

notes

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.

periodoptionalDurationperiodoptionalDurationperiodoptionalDurationPeriodoptionalDurationPeriodoptionalDuration = Duration.minutes(5) #
The period over which the search expression's statistics are applied.

This period overrides the period defined within the search expression.

searchAccountoptionalstringsearch_accountoptionalstrsearchAccountoptionalStringSearchAccountoptionalstringSearchAccountoptional*string #
Account to evaluate search expressions within.

Default: Deployment account.

searchRegionoptionalstringsearch_regionoptionalstrsearchRegionoptionalStringSearchRegionoptionalstringSearchRegionoptional*string #
Region to evaluate search expressions within.

Default: Deployment region.

visibleoptionalbooleanvisibleoptionalboolvisibleoptionalBooleanVisibleoptionalboolVisibleoptional*bool = true #
Whether the time series produced by this search expression should be visible in dashboard graphs.

Setting this to false keeps the time series on the widget without rendering them, so they can still be toggled on in the CloudWatch console.