# MathExpressionOptions

Configurable options for MathExpressions.

- Source: [`aws-cloudwatch/lib/metric.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-cloudwatch/lib/metric.ts#L183)

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
const mathExpressionOptions: cloudwatch.MathExpressionOptions = {
  color: 'color',
  label: 'label',
  period: cdk.Duration.minutes(30),
  searchAccount: 'searchAccount',
  searchRegion: 'searchRegion',
};
```

## Properties

- `color`: string — Color for this metric when added to a Graph in a Dashboard.

  **Default:** Automatic color

- `label`: string — Label for this expression when added to a Graph in a Dashboard.

  **Default:** Expression value is used as label

  If this expression evaluates to more than one time series (for
  example, through the use of `METRICS()` or `SEARCH()` expressions),
  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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html)
  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
  math expression produces more than one time series, the maximum
  will be shown for each individual time series produce by this
  math expression.

- `period`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = Duration.minutes(5) — The period over which the math expression's statistics are applied.

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

- `searchAccount`: string — Account to evaluate search expressions within.

  **Default:** Deployment account.

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

- `searchRegion`: string — Region to evaluate search expressions within.

  **Default:** Deployment region.

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