CompositeAlarmProps Struct
Properties for creating a Composite Alarm.
Example
ts
declare const alarm1: cloudwatch.Alarm;
declare const alarm2: cloudwatch.Alarm;
declare const onAlarmAction: cloudwatch.IAlarmAction;
declare const onOkAction: cloudwatch.IAlarmAction;
declare const actionsSuppressor: cloudwatch.Alarm;
const alarmRule = cloudwatch.AlarmRule.anyOf(alarm1, alarm2);
const myCompositeAlarm = new cloudwatch.CompositeAlarm(this, 'MyAwesomeCompositeAlarm', {
alarmRule,
actionsSuppressor,
});
myCompositeAlarm.addAlarmAction(onAlarmAction);
myCompositeAlarm.addOkAction(onOkAction);
Properties
actionsEnabledbooleanactions_enabledboolactionsEnabledBooleanActionsEnabledboolActionsEnabled*bool= true#Whether the actions for this alarm are enabled.
actionsSuppressorIAlarmRefactions_suppressorIAlarmRefactionsSuppressorIAlarmRefActionsSuppressorIAlarmRefActionsSuppressorIAlarmRef#Actions will be suppressed if the suppressor alarm is in the ALARM state.
Default: alarm will not be suppressed.
actionsSuppressorExtensionPeriodDurationactions_suppressor_extension_periodDurationactionsSuppressorExtensionPeriodDurationActionsSuppressorExtensionPeriodDurationActionsSuppressorExtensionPeriodDuration#The maximum duration that the composite alarm waits after suppressor alarm goes out of the ALARM state.
Default: 1 minute extension period will be set.
After this time, the composite alarm performs its actions.
actionsSuppressorWaitPeriodDurationactions_suppressor_wait_periodDurationactionsSuppressorWaitPeriodDurationActionsSuppressorWaitPeriodDurationActionsSuppressorWaitPeriodDuration#The maximum duration that the composite alarm waits for the suppressor alarm to go into the ALARM state.
Default: 1 minute wait period will be set.
After this time, the composite alarm performs its actions.
alarmDescriptionstringalarm_descriptionstralarmDescriptionStringAlarmDescriptionstringAlarmDescription*string#Description for the alarm.
Default: No description.
alarmRuleIAlarmRulealarm_ruleIAlarmRulealarmRuleIAlarmRuleAlarmRuleIAlarmRuleAlarmRuleIAlarmRulerequired#Expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.
compositeAlarmNamestringcomposite_alarm_namestrcompositeAlarmNameStringCompositeAlarmNamestringCompositeAlarmName*string#Name of the alarm.
Default: Automatically generated name.