interface CfnCompositeAlarmProps

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

Properties for defining a CfnCompositeAlarm.

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';
const cfnCompositeAlarmProps: cloudwatch.CfnCompositeAlarmProps = {
  alarmRule: 'alarmRule',

  // the properties below are optional
  actionsEnabled: false,
  actionsSuppressor: 'actionsSuppressor',
  actionsSuppressorExtensionPeriod: 123,
  actionsSuppressorWaitPeriod: 123,
  alarmActions: ['alarmActions'],
  alarmDescription: 'alarmDescription',
  alarmName: 'alarmName',
  insufficientDataActions: ['insufficientDataActions'],
  okActions: ['okActions'],
};

Properties

Name	Type	Description
alarmRule	string	An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.
actionsEnabled?	boolean | IResolvable	Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.
actionsSuppressor?	string	Actions will be suppressed if the suppressor alarm is in the ALARM state.
actionsSuppressorExtensionPeriod?	number	The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state.
actionsSuppressorWaitPeriod?	number	The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state.
alarmActions?	string[]	The actions to execute when this alarm transitions to the ALARM state from any other state.
alarmDescription?	string	The description for the composite alarm.
alarmName?	string	The name for the composite alarm.
insufficientDataActions?	string[]	The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
okActions?	string[]	The actions to execute when this alarm transitions to the OK state from any other state.

---

alarmRule

Type: string

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

For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.

You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.

Functions can include the following:

• ALARM("alarm-name or alarm-ARN") is TRUE if the named alarm is in ALARM state.
• OK("alarm-name or alarm-ARN") is TRUE if the named alarm is in OK state.
• INSUFFICIENT_DATA("alarm-name or alarm-ARN") is TRUE if the named alarm is in INSUFFICIENT_DATA state.
• TRUE always evaluates to TRUE.
• FALSE always evaluates to FALSE.

TRUE and FALSE are useful for testing a complex AlarmRule structure, and for testing your alarm actions.

For more information about AlarmRule syntax, see PutCompositeAlarm in the Amazon CloudWatch API Reference .

---

actionsEnabled?

Type: boolean | IResolvable (optional)

Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.

The default is TRUE.

---

actionsSuppressor?

Type: string (optional)

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

ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

---

actionsSuppressorExtensionPeriod?

Type: number (optional)

The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state.

After this time, the composite alarm performs its actions.

ExtensionPeriod is required only when ActionsSuppressor is specified.

---

actionsSuppressorWaitPeriod?

Type: number (optional)

The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state.

After this time, the composite alarm performs its actions.

WaitPeriod is required only when ActionsSuppressor is specified.

---

alarmActions?

Type: string[] (optional)

The actions to execute when this alarm transitions to the ALARM state from any other state.

Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see PutCompositeAlarm in the Amazon CloudWatch API Reference .

---

alarmDescription?

Type: string (optional)

The description for the composite alarm.

---

alarmName?

Type: string (optional)

The name for the composite alarm.

This name must be unique within your AWS account.

---

insufficientDataActions?

Type: string[] (optional)

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.

Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see PutCompositeAlarm in the Amazon CloudWatch API Reference .

---

okActions?

Type: string[] (optional)

The actions to execute when this alarm transitions to the OK state from any other state.

Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see PutCompositeAlarm in the Amazon CloudWatch API Reference .