Class: Aws::CloudWatchLogs::Types::CreateScheduledQueryRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchLogs::Types::CreateScheduledQueryRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cloudwatchlogs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

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

• #destination_configuration ⇒ Types::DestinationConfiguration

  Configuration for where to deliver query results.

• #end_time_offset ⇒ Integer

  The time offset in seconds that defines the end of the lookback period for the query.

• #execution_role_arn ⇒ String

  The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination.

• #log_group_identifiers ⇒ Array<String>

  An array of log group names or ARNs to query.

• #name ⇒ String

  The name of the scheduled query.

• #query_language ⇒ String

  The query language to use for the scheduled query.

• #query_string ⇒ String

  The query string to execute.

• #schedule_end_time ⇒ Integer

  The end time for the scheduled query in Unix epoch format.

• #schedule_expression ⇒ String

  A cron expression that defines when the scheduled query runs.

• #schedule_start_time ⇒ Integer

  The start time for the scheduled query in Unix epoch format.

• #start_time_offset ⇒ Integer

  The time offset in seconds that defines the lookback period for the query.

• #state ⇒ String

  The initial state of the scheduled query.

• #tags ⇒ Hash<String,String>

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

• #timezone ⇒ String

  The timezone for evaluating the schedule expression.

Instance Attribute Details

#description ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#destination_configuration ⇒ Types::DestinationConfiguration

Configuration for where to deliver query results. Supports Amazon S3 destinations for storing query output and lookup table destinations for automatically refreshing lookup tables with query results. You can configure one or both destination types.

Returns:

• (Types::DestinationConfiguration)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#end_time_offset ⇒ Integer

The time offset in seconds that defines the end of the lookback period for the query. Together with startTimeOffset, this determines the time window relative to the execution time over which the query runs.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arn ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_identifiers ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the scheduled query. The name must be unique within your account and region. Length must be between 1 and 300 characters.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#query_language ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#query_string ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_end_time ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_start_time ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#start_time_offset ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#timezone ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1303

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :end_time_offset,
  :destination_configuration,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :state,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end