AWS SDK Version 3 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.

Container for the parameters to the CreateScheduledQuery operation. Creates a scheduled query that runs CloudWatch Logs Insights queries at regular intervals. Scheduled queries enable proactive monitoring by automatically executing queries to detect patterns and anomalies in your log data. Query results can be delivered to Amazon S3 for analysis or further processing.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudWatchLogs.AmazonCloudWatchLogsRequest
      Amazon.CloudWatchLogs.Model.CreateScheduledQueryRequest

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

Syntax

C#
public class CreateScheduledQueryRequest : AmazonCloudWatchLogsRequest
         IAmazonWebServiceRequest

The CreateScheduledQueryRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Description System.String

Gets and sets the property Description.

An optional description for the scheduled query to help identify its purpose and functionality.

Public Property DestinationConfiguration Amazon.CloudWatchLogs.Model.DestinationConfiguration

Gets and sets the property DestinationConfiguration.

Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.

Public Property ExecutionRoleArn System.String

Gets and sets the property ExecutionRoleArn.

The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination. The role must have permissions to read from the specified log groups and write to the destination.

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

Gets and sets the property LogGroupIdentifiers.

An array of log group names or ARNs to query. You can specify between 1 and 50 log groups. Log groups can be identified by name or full ARN.

Public Property Name System.String

Gets and sets the property Name.

The name of the scheduled query. The name must be unique within your account and region. Valid characters are alphanumeric characters, hyphens, underscores, and periods. Length must be between 1 and 255 characters.

Public Property QueryLanguage Amazon.CloudWatchLogs.QueryLanguage

Gets and sets the property QueryLanguage.

The query language to use for the scheduled query. Valid values are LogsQL, PPL, and SQL.

Public Property QueryString System.String

Gets and sets the property QueryString.

The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.

Public Property ScheduleEndTime System.Int64

Gets and sets the property ScheduleEndTime.

The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.

Public Property ScheduleExpression System.String

Gets and sets the property ScheduleExpression.

A cron expression that defines when the scheduled query runs. The expression uses standard cron syntax and supports minute-level precision. Maximum length is 256 characters.

Public Property ScheduleStartTime System.Int64

Gets and sets the property ScheduleStartTime.

The start time for the scheduled query in Unix epoch format. The query will not execute before this time.

Public Property StartTimeOffset System.Int64

Gets and sets the property StartTimeOffset.

The time offset in seconds that defines the lookback period for the query. This determines how far back in time the query searches from the execution time.

Public Property State Amazon.CloudWatchLogs.ScheduledQueryState

Gets and sets the property State.

The initial state of the scheduled query. Valid values are ENABLED and DISABLED. Default is ENABLED.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

Key-value pairs to associate with the scheduled query for resource management and cost allocation.

Public Property Timezone System.String

Gets and sets the property Timezone.

The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.

Version Information

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

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5