SearchExpression

class aws_cdk.aws_cloudwatch.SearchExpression(*, expression, color=None, label=None, period=None, search_account=None, search_region=None)

Bases: object

A CloudWatch search expression for dynamically finding and graphing multiple related metrics.

Search expressions allow you to search for and graph multiple related metrics from a single expression. This is particularly useful in dynamic environments where the exact metric names or dimensions may not be known at deployment time.

Example:

search_expression = cloudwatch.SearchExpression(
    expression="SEARCH('{AWS/EC2,InstanceId} CPUUtilization', 'Average', 300)",
    label="EC2 CPU Utilization",
    period=Duration.minutes(5)
)

This class does not represent a resource, so hence is not a construct. Instead, SearchExpression is an abstraction that makes it easy to specify metrics for use in graphs.

ExampleMetadata:: infused

Example:

cpu_utilization = cloudwatch.SearchExpression(
    expression="SEARCH('{AWS/EC2,InstanceId} MetricName="CPUUtilization"', 'Average', 900)",
    label="EC2 CPU Utilization",
    color="#ff7f0e"
)

Parameters:

expression (str) – 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 (Optional[str]) – 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.
label (Optional[str]) – 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.
period (Optional[Duration]) – 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)
search_account (Optional[str]) – Account to evaluate search expressions within. Default: - Deployment account.
search_region (Optional[str]) – Region to evaluate search expressions within. Default: - Deployment region.

Methods

to_metric_config()

Inspect the details of the metric object.

Return type:: MetricConfig

to_string()

Returns a string representation of an object.

Return type:: str

with_(*, color=None, label=None, period=None, search_account=None, search_region=None)

Return a copy of SearchExpression with properties changed.

All properties except expression can be changed.

Parameters:

color (Optional[str]) – 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.
label (Optional[str]) –
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.
period (Optional[Duration]) – 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)
search_account (Optional[str]) – Account to evaluate search expressions within. Default: - Deployment account.
search_region (Optional[str]) – Region to evaluate search expressions within. Default: - Deployment region.

Return type:

SearchExpression

Attributes

color: Hex color code (e.g. ‘#00ff00’), to use when rendering the resulting metrics in a graph. If multiple time series are returned, color is assigned to the first metric, color for the other metrics is automatically assigned.

expression: The search expression defining the metrics to be retrieved.

label: The label is used as a prefix for the title of each metric returned by the search expression.

period: The aggregation period for the metrics produced by the Search Expression.

search_account: Account to evaluate search expressions within.

search_region: Region to evaluate search expressions within.

warnings

(deprecated) Warnings generated by this search expression.

Deprecated:

use warningsV2

Stability:

deprecated

warnings_v2: Warnings generated by this search expression.