MetricExpressionConfig¶

class aws_cdk.aws_cloudwatch.MetricExpressionConfig(*, expression, period, using_metrics, search_account=None, search_region=None)¶

Bases: object

Properties for a concrete metric.

Parameters

expression (str) – Math expression for the metric.
period (Union[int, float]) – How many seconds to aggregate over.
using_metrics (Mapping[str, IMetric]) – Metrics used in the math expression.
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.

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cloudwatch as cloudwatch

# metric: cloudwatch.Metric

metric_expression_config = cloudwatch.MetricExpressionConfig(
    expression="expression",
    period=123,
    using_metrics={
        "using_metrics_key": metric
    },

    # the properties below are optional
    search_account="searchAccount",
    search_region="searchRegion"
)

Attributes

expression¶

Math expression for the metric.

Return type: str

period¶

How many seconds to aggregate over.

Return type: Union[int, float]

search_account¶

Account to evaluate search expressions within.

Default

Deployment account.

Return type

Optional[str]

search_region¶

Region to evaluate search expressions within.

Default

Deployment region.

Return type

Optional[str]

using_metrics¶

Metrics used in the math expression.

Return type: Mapping[str, IMetric]