interface MetricAlarmConfig ⚠️

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

⚠️ Deprecated: Replaced by MetricConfig

Obtainable from MathExpression.toAlarmConfig(), Metric.toAlarmConfig()

Properties used to construct the Metric identifying part of an Alarm.

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 value: any;
const metricAlarmConfig: cloudwatch.MetricAlarmConfig = {
  metricName: 'metricName',
  namespace: 'namespace',
  period: 123,

  // the properties below are optional
  dimensions: [{
    name: 'name',
    value: value,
  }],
  extendedStatistic: 'extendedStatistic',
  statistic: cloudwatch.Statistic.SAMPLE_COUNT,
  unit: cloudwatch.Unit.SECONDS,
};

Properties

Name	Type	Description
metricName⚠️	`string`	Name of the metric.
namespace⚠️	`string`	Namespace of the metric.
period⚠️	`number`	How many seconds to aggregate over.
dimensions?⚠️	`Dimension[]`	The dimensions to apply to the alarm.
extendedStatistic?⚠️	`string`	Percentile aggregation function to use.
statistic?⚠️	`Statistic`	Simple aggregation function to use.
unit?⚠️	`Unit`	The unit of the alarm.

metricName⚠️

⚠️ Deprecated: Replaced by MetricConfig

Type: string

Name of the metric.

namespace⚠️

⚠️ Deprecated: Replaced by MetricConfig

Type: string

Namespace of the metric.

period⚠️

⚠️ Deprecated: Replaced by MetricConfig

Type: number

How many seconds to aggregate over.

dimensions?⚠️

⚠️ Deprecated: Replaced by MetricConfig

Type: Dimension[] (optional)

The dimensions to apply to the alarm.

extendedStatistic?⚠️

⚠️ Deprecated: Replaced by MetricConfig

Type: string (optional)

Percentile aggregation function to use.

statistic?⚠️

⚠️ Deprecated: Replaced by MetricConfig

Type: Statistic (optional)

Simple aggregation function to use.

unit?⚠️

⚠️ Deprecated: Replaced by MetricConfig

Type: Unit (optional)

The unit of the alarm.