View a markdown version of this page

AWS::CloudWatch::LogAlarm ScheduledQueryConfiguration - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::CloudWatch::LogAlarm ScheduledQueryConfiguration

The configuration of the underlying CloudWatch Logs scheduled query that this alarm evaluates, including the query string, log groups, schedule, and aggregation expression.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

Properties

AggregationExpression

The expression that defines how to aggregate query results into one or more scalar values for alarm evaluation. For example, count(*) or avg(latency) by host | sort desc. Length constraints: minimum 1 character, maximum 2048 characters.

Required: Yes

Type: String

Update requires: No interruption

LogGroupIdentifiers

The log groups to query. Each entry can be a log group name or ARN. Use the ARN form when querying log groups in a different account (for example, when running cross-account queries from a monitoring account). The list must contain between 1 and 50 entries.

Required: Yes

Type: Array of String

Update requires: No interruption

QueryString

The CloudWatch Logs query to execute on each scheduled run. Length constraints: maximum of 10,000 characters.

Required: Yes

Type: String

Update requires: No interruption

ScheduleConfiguration

The schedule and time-range offset configuration for the underlying scheduled query.

Required: Yes

Type: ScheduleConfiguration

Update requires: No interruption

ScheduledQueryRoleARN

The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes when executing the scheduled query against the configured log groups.

Required: Yes

Type: String

Update requires: No interruption