Builder

class Builder

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
var name: String?

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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