composite_alarm

Gets an individual composite_alarm resource

Overview

Name	composite_alarm
Type	Resource
Description	composite_alarm
Id	awscc.cloudwatch.composite_alarm

Fields

Name	Datatype	Description
arn	string	Amazon Resource Name (ARN) of the alarm
alarm_name	string	The name of the Composite Alarm
alarm_rule	string	Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
alarm_description	string	The description of the alarm
actions_enabled	boolean	Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
ok_actions	array	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).
alarm_actions	array	The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).
insufficient_data_actions	array	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).
actions_suppressor	string	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.
actions_suppressor_wait_period	integer	Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
actions_suppressor_extension_period	integer	Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
arn,
alarm_name,
alarm_rule,
alarm_description,
actions_enabled,
ok_actions,
alarm_actions,
insufficient_data_actions,
actions_suppressor,
actions_suppressor_wait_period,
actions_suppressor_extension_period
FROM awscc.cloudwatch.composite_alarm
WHERE data__Identifier = '<AlarmName>';

Permissions

To operate on the composite_alarm resource, the following permissions are required:

Read

cloudwatch:DescribeAlarms

Update

cloudwatch:DescribeAlarms,
cloudwatch:PutCompositeAlarm

Delete

cloudwatch:DescribeAlarms,
cloudwatch:DeleteAlarms