MathExpressionOptions

class aws_cdk.aws_cloudwatch.MathExpressionOptions(*, color=None, label=None, period=None, search_account=None, search_region=None)

Bases: object

Configurable options for MathExpressions.

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.

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
import aws_cdk.core as cdk

math_expression_options = cloudwatch.MathExpressionOptions(
    color="color",
    label="label",
    period=cdk.Duration.minutes(30),
    search_account="searchAccount",
    search_region="searchRegion"
)

Attributes

color

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

Default
  • Automatic color

Return type

Optional[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]