Interface ICompositeAlarmProps

Properties for creating a Composite Alarm.

Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICompositeAlarmProps
Syntax (vb)
Public Interface ICompositeAlarmProps
Remarks

ExampleMetadata: infused

Examples
Alarm alarm1;
Alarm alarm2;
Alarm alarm3;
Alarm alarm4;


var alarmRule = AlarmRule.AnyOf(AlarmRule.AllOf(AlarmRule.AnyOf(alarm1, AlarmRule.FromAlarm(alarm2, AlarmState.OK), alarm3), AlarmRule.Not(AlarmRule.FromAlarm(alarm4, AlarmState.INSUFFICIENT_DATA))), AlarmRule.FromBoolean(false));

new CompositeAlarm(this, "MyAwesomeCompositeAlarm", new CompositeAlarmProps {
    AlarmRule = alarmRule
});

Synopsis

Properties

ActionsEnabled

Whether the actions for this alarm are enabled.
ActionsSuppressor

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

The maximum duration that the composite alarm waits after suppressor alarm goes out of the ALARM state.
ActionsSuppressorWaitPeriod

The maximum duration that the composite alarm waits for the suppressor alarm to go into the ALARM state.
AlarmDescription

Description for the alarm.
AlarmRule

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

Name of the alarm.

Properties

ActionsEnabled

Whether the actions for this alarm are enabled.

virtual Nullable<bool> ActionsEnabled { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: true

ActionsSuppressor

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

virtual IAlarm ActionsSuppressor { get; }
Property Value

IAlarm

Remarks

Default: - alarm will not be suppressed.

ActionsSuppressorExtensionPeriod

The maximum duration that the composite alarm waits after suppressor alarm goes out of the ALARM state.

virtual Duration ActionsSuppressorExtensionPeriod { get; }
Property Value

Duration

Remarks

After this time, the composite alarm performs its actions.

Default: - 1 minute extension period will be set.

ActionsSuppressorWaitPeriod

The maximum duration that the composite alarm waits for the suppressor alarm to go into the ALARM state.

virtual Duration ActionsSuppressorWaitPeriod { get; }
Property Value

Duration

Remarks

After this time, the composite alarm performs its actions.

Default: - 1 minute wait period will be set.

AlarmDescription

Description for the alarm.

virtual string AlarmDescription { get; }
Property Value

System.String

Remarks

Default: - No description.

AlarmRule

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

IAlarmRule AlarmRule { get; }
Property Value

IAlarmRule

CompositeAlarmName

Name of the alarm.

virtual string CompositeAlarmName { get; }
Property Value

System.String

Remarks

Default: - Automatically generated name.