AWS Fundamentals Logo
AWS Fundamentals
AWS::CloudWatch::CompositeAlarm

CloudWatch CompositeAlarm

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

Properties

11 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
AlarmRule
string
Required
ActionsEnabled
boolean
ActionsSuppressor
string
ActionsSuppressorExtensionPeriod
integer
ActionsSuppressorWaitPeriod
integer
AlarmActions
Array<string>
AlarmDescription
string
AlarmName
string
Create-only
InsufficientDataActions
Array<string>
OKActions
Array<string>
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
ArnstringAmazon Resource Name (ARN) of the alarm

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::CloudWatch::CompositeAlarm

Resources:
  MyResource:
    Type: AWS::CloudWatch::CompositeAlarm
    Properties:
      AlarmRule: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

cloudwatch:DescribeAlarmscloudwatch:PutCompositeAlarmcloudwatch:TagResource

read

cloudwatch:DescribeAlarmscloudwatch:ListTagsForResource

update

cloudwatch:DescribeAlarmscloudwatch:PutCompositeAlarmcloudwatch:TagResourcecloudwatch:UntagResource

delete

cloudwatch:DescribeAlarmscloudwatch:DeleteAlarms

list

cloudwatch:DescribeAlarms

Get the CloudWatch Cheat Sheet

Everything you need to know about CloudWatch on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceCloudWatch
Properties12
Required1
TaggingSupported
Primary IDAlarmName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

AlarmName

Related Resources

External Links