interface SearchExpressionProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.CloudWatch.SearchExpressionProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#SearchExpressionProps |
 Java | software.amazon.awscdk.services.cloudwatch.SearchExpressionProps |
 Python | aws_cdk.aws_cloudwatch.SearchExpressionProps |
 TypeScript (source) | aws-cdk-lib » aws_cloudwatch » SearchExpressionProps |
Properties for a SearchExpression.
Example
const cpuUtilization = new cloudwatch.SearchExpression({
expression: "SEARCH('{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"', 'Average', 900)",
label: 'EC2 CPU Utilization',
color: '#ff7f0e',
});
Properties
| Name | Type | Description |
|---|---|---|
| expression | string | The search expression defining the metrics to be retrieved. |
| 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. |
expression
Type:
string
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
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.