AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.CloudWatch.Model.ScheduledQueryConfiguration

Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z

Syntax

C#
public class ScheduledQueryConfiguration

The ScheduledQueryConfiguration type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AggregationExpression System.String

Gets and sets the property 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.

Public Property LogGroupIdentifiers System.Collections.Generic.List<System.String>

Gets and sets the property 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.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property QueryARN System.String

Gets and sets the property QueryARN.

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

Public Property QueryString System.String

Gets and sets the property QueryString.

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

Public Property ScheduleConfiguration Amazon.CloudWatch.Model.ScheduleConfiguration

Gets and sets the property ScheduleConfiguration.

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

Public Property ScheduledQueryRoleARN System.String

Gets and sets the property ScheduledQueryRoleARN.

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

Public Property Tags System.Collections.Generic.List<Amazon.CloudWatch.Model.Tag>

Gets and sets the property Tags.

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer