composite_alarms_list_only
Lists composite_alarms
in a region or regions, for all properties use composite_alarms
Overview
Name | composite_alarms_list_only |
Type | Resource |
Description | The AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression |
Id | aws.cloudwatch.composite_alarms_list_only |
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. |
tags | array | A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
SELECT
examples
Lists all composite_alarms
in a region.
SELECT
region,
alarm_name
FROM aws.cloudwatch.composite_alarms_list_only
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the composite_alarms_list_only
resource, see composite_alarms