interface SearchExpressionOptions
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.CloudWatch.SearchExpressionOptions |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#SearchExpressionOptions |
 Java | software.amazon.awscdk.services.cloudwatch.SearchExpressionOptions |
 Python | aws_cdk.aws_cloudwatch.SearchExpressionOptions |
 TypeScript (source) | aws-cdk-lib » aws_cloudwatch » SearchExpressionOptions |
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 * 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',
};
Properties
| Name | Type | Description |
|---|---|---|
| color? | string | Color for the metric produced by the search expression. |
| label? | string | Label for this search expression when added to a Graph in a Dashboard. |
| period? | Duration | The period over which the search expression's statistics are applied. |
| search | string | Account to evaluate search expressions within. |
| search | string | Region to evaluate search expressions within. |
color?
Type:
string
(optional, default: Automatically assigned.)
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.
label?
Type:
string
(optional, default: No 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.
period?
Type:
Duration
(optional, default: Duration.minutes(5))
The period over which the search expression's statistics are applied.
This period overrides the period defined within the search expression.
searchAccount?
Type:
string
(optional, default: Deployment account.)
Account to evaluate search expressions within.
searchRegion?
Type:
string
(optional, default: Deployment region.)
Region to evaluate search expressions within.