View a markdown version of this page

ScheduledQueryConfiguration - Amazon CloudWatch
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).

ScheduledQueryConfiguration

The configuration of the CloudWatch Logs scheduled query that backs a log alarm.

Contents

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

QueryString

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10000.

Required: Yes

ScheduleConfiguration

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

Type: ScheduleConfiguration object

Required: Yes

ScheduledQueryRoleARN

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: Yes

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

QueryARN

The Amazon Resource Name (ARN) of the CloudWatch Logs scheduled query that the alarm uses. This field is populated in DescribeAlarms responses.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Tags

A list of key-value pairs to associate with the underlying scheduled query resource.

Type: Array of Tag objects

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: