AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

CompositeAlarm

A Composite Alarm based on Alarm Rule.

Import

import { CompositeAlarm } from 'aws-cdk-lib/aws-cloudwatch';

Or use the module namespace:

import * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';
// cloudwatch.CompositeAlarm

Properties

Configuration passed to the constructor as CompositeAlarmProps.

alarmRuleRequired
IAlarmRule

Expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.

actionsEnabledOptional
boolean

Whether the actions for this alarm are enabled.

Default: true

actionsSuppressorOptional
IAlarmRef

Actions will be suppressed if the suppressor alarm is in the ALARM state.

Default: - alarm will not be suppressed.

actionsSuppressorExtensionPeriodOptional
Duration

The maximum duration that the composite alarm waits after suppressor alarm goes out of the ALARM state. After this time, the composite alarm performs its actions.

Default: - 1 minute extension period will be set.

actionsSuppressorWaitPeriodOptional
Duration

The maximum duration that the composite alarm waits for the suppressor alarm to go into the ALARM state. After this time, the composite alarm performs its actions.

Default: - 1 minute wait period will be set.

alarmDescriptionOptional
string

Description for the alarm.

Default: - No description.

compositeAlarmNameOptional
string

Name of the alarm.

Default: - Automatically generated name.

Get the Amazon CloudWatch Cheat Sheet

Everything you need to know about Amazon CloudWatch on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL2 (Higher-level)
Moduleaws-cloudwatch
Properties7

Related Constructs

Explore This Service

External Links