MathExpressionProps

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

Bases: aws_cdk.aws_cloudwatch.MathExpressionOptions

Properties for a MathExpression.

Parameters
  • color (Optional[str]) – Color for this metric when added to a Graph in a Dashboard. Default: - Automatic color

  • label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - Expression value is used as label

  • period (Optional[Duration]) – The period over which the expression’s statistics are applied. This period overrides all periods in the metrics used in this math expression. Default: Duration.minutes(5)

  • search_account (Optional[str]) – Account to evaluate search expressions within. Specifying a searchAccount has no effect to the account used for metrics within the expression (passed via usingMetrics). Default: - Deployment account.

  • search_region (Optional[str]) – Region to evaluate search expressions within. Specifying a searchRegion has no effect to the region used for metrics within the expression (passed via usingMetrics). Default: - Deployment region.

  • expression (str) – The expression defining the metric. When an expression contains a SEARCH function, it cannot be used within an Alarm.

  • using_metrics (Optional[Mapping[str, IMetric]]) – The metrics used in the expression, in a map. The key is the identifier that represents the given metric in the expression, and the value is the actual Metric object. Default: - Empty map.

Example:

# fn is of type Function


all_problems = cloudwatch.MathExpression(
    expression="errors + throttles",
    using_metrics={
        "errors": fn.metric_errors(),
        "faults": fn.metric_throttles()
    }
)

Attributes

color

Color for this metric when added to a Graph in a Dashboard.

Default
  • Automatic color

Return type

Optional[str]

expression

The expression defining the metric.

When an expression contains a SEARCH function, it cannot be used within an Alarm.

Return type

str

label

Label for this metric when added to a Graph in a Dashboard.

Default
  • Expression value is used as label

Return type

Optional[str]

period

The period over which the expression’s statistics are applied.

This period overrides all periods in the metrics used in this math expression.

Default

Duration.minutes(5)

Return type

Optional[Duration]

search_account

Account to evaluate search expressions within.

Specifying a searchAccount has no effect to the account used for metrics within the expression (passed via usingMetrics).

Default
  • Deployment account.

Return type

Optional[str]

search_region

Region to evaluate search expressions within.

Specifying a searchRegion has no effect to the region used for metrics within the expression (passed via usingMetrics).

Default
  • Deployment region.

Return type

Optional[str]

using_metrics

The metrics used in the expression, in a map.

The key is the identifier that represents the given metric in the expression, and the value is the actual Metric object.

Default
  • Empty map.

Return type

Optional[Mapping[str, IMetric]]