interface MetricExpressionConfig

Language	Type name
.NET	Amazon.CDK.AWS.CloudWatch.MetricExpressionConfig
Java	software.amazon.awscdk.services.cloudwatch.MetricExpressionConfig
Python	aws_cdk.aws_cloudwatch.MetricExpressionConfig
TypeScript (source)	@aws-cdk/aws-cloudwatch » MetricExpressionConfig

Properties for a concrete metric.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloudwatch from '@aws-cdk/aws-cloudwatch';

declare const metric: cloudwatch.Metric;
const metricExpressionConfig: cloudwatch.MetricExpressionConfig = {
  expression: 'expression',
  period: 123,
  usingMetrics: {
    usingMetricsKey: metric,
  },

  // the properties below are optional
  searchAccount: 'searchAccount',
  searchRegion: 'searchRegion',
};

Properties

Name	Type	Description
expression	string	Math expression for the metric.
period	number	How many seconds to aggregate over.
usingMetrics	{ [string]: IMetric }	Metrics used in the math expression.
searchAccount?	string	Account to evaluate search expressions within.
searchRegion?	string	Region to evaluate search expressions within.

---

expression

Type: string

Math expression for the metric.

---

period

Type: number

How many seconds to aggregate over.

---

usingMetrics

Type: { [string]: IMetric }

Metrics used in the math expression.

---

searchAccount?

Type: string (optional, default: Deployment account.)

Account to evaluate search expressions within.

---

searchRegion?

Type: string (optional, default: Deployment region.)

Region to evaluate search expressions within.