SearchExpressionProps Struct
Properties for a SearchExpression.
| Source | aws-cloudwatch/lib/metric.ts |
|---|---|
| Type last changed |
Example
const searchExpression = new cloudwatch.SearchExpression({
expression: "SEARCH('{AWS/EC2,InstanceId} CPUUtilization', 'Average', 300)",
label: 'EC2 CPU Utilization',
period: Duration.minutes(5),
});
search_expression = cloudwatch.SearchExpression(
expression="SEARCH('{AWS/EC2,InstanceId} CPUUtilization', 'Average', 300)",
label="EC2 CPU Utilization",
period=Duration.minutes(5)
)
SearchExpression searchExpression = SearchExpression.Builder.create()
.expression("SEARCH('{AWS/EC2,InstanceId} CPUUtilization', 'Average', 300)")
.label("EC2 CPU Utilization")
.period(Duration.minutes(5))
.build();
// Install: dotnet add package Amazon.CDK.Lib
var searchExpression = new SearchExpression(new SearchExpressionProps {
Expression = "SEARCH('{AWS/EC2,InstanceId} CPUUtilization', 'Average', 300)",
Label = "EC2 CPU Utilization",
Period = Duration.Minutes(5)
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
searchExpression := cloudwatch.NewSearchExpression(&SearchExpressionProps{
Expression: jsii.String("SEARCH('{AWS/EC2,InstanceId} CPUUtilization', 'Average', 300)"),
Label: jsii.String("EC2 CPU Utilization"),
Period: awscdk.Duration_Minutes(jsii.Number(5)),
})
Properties
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.
notes
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
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) #This period overrides the period defined within the search expression.
searchAccountoptionalstringsearch_accountoptionalstrsearchAccountoptionalStringSearchAccountoptionalstringSearchAccountoptional*string #Default: Deployment account.
searchRegionoptionalstringsearch_regionoptionalstrsearchRegionoptionalStringSearchRegionoptionalstringSearchRegionoptional*string #Default: Deployment region.
visibleoptionalbooleanvisibleoptionalboolvisibleoptionalBooleanVisibleoptionalboolVisibleoptional*bool = true #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.