AWS Fundamentals Logo
AWS Fundamentals
AWS::CloudWatch::LogAlarm

CloudWatch LogAlarm

Resource Type definition for AWS::CloudWatch::LogAlarm. A LogAlarm evaluates scheduled query results from CloudWatch Logs and triggers actions when thresholds are breached.

Properties

15 configurable properties. 5 required. Click a row to see details.

Filter:
PropertyTypeFlags
ComparisonOperator
string
Required
QueryResultsToAlarm
integer
Required
QueryResultsToEvaluate
integer
Required
ScheduledQueryConfiguration
ScheduledQueryConfiguration
Required
Threshold
number
Required
ActionLogLineCount
integer
ActionLogLineRoleArn
string
ActionsEnabled
boolean
AlarmActions
Array<string>
AlarmDescription
string
AlarmName
string
Create-only
InsufficientDataActions
Array<string>
OKActions
Array<string>
Tags
Array<Tag>
TreatMissingData
string

Return Values

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

AttributeTypeDescription
ArnstringThe ARN of the log 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::LogAlarm

Resources:
  MyResource:
    Type: AWS::CloudWatch::LogAlarm
    Properties:
      ComparisonOperator: "value"
      Threshold: 1
      QueryResultsToAlarm: 1
      QueryResultsToEvaluate: 1
      ScheduledQueryConfiguration: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

cloudwatch:PutLogAlarmcloudwatch:DescribeAlarmscloudwatch:TagResourcelogs:GetScheduledQuerylogs:CreateScheduledQuerylogs:UpdateScheduledQuerylogs:DeleteScheduledQueryiam:PassRole

update

cloudwatch:PutLogAlarmcloudwatch:DescribeAlarmscloudwatch:TagResourcecloudwatch:UntagResourcelogs:GetScheduledQuerylogs:CreateScheduledQuerylogs:UpdateScheduledQuerylogs:DeleteScheduledQueryiam:PassRole

delete

cloudwatch:DeleteAlarmscloudwatch:DescribeAlarmslogs:GetScheduledQuerylogs:CreateScheduledQuerylogs:DeleteScheduledQuery

list

cloudwatch:DescribeAlarms

read

cloudwatch:DescribeAlarmscloudwatch:ListTagsForResource

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
Properties16
Required5
TaggingSupported
Primary IDAlarmName

Supported Operations

CreateUpdateDeleteListRead

Immutable After Creation

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

AlarmName

Related Resources

External Links