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.

• #destination_configuration ⇒ Types::DestinationConfiguration

  Configuration for destinations where the query results will be delivered after successful execution.

• #execution_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role that CloudWatch Logs will assume to execute the scheduled query and deliver results to the specified destinations.

• #log_group_identifiers ⇒ Array<String>

  The log group identifiers to query.

• #name ⇒ String

  A unique name for the scheduled query within the region for an AWS account.

• #query_language ⇒ String

  The query language to use for the scheduled query.

• #query_string ⇒ String

  The CloudWatch Logs Insights query string to execute.

• #schedule_end_time ⇒ Integer

  The end time for the query schedule in Unix epoch time (seconds since January 1, 1970, 00:00:00 UTC).

• #schedule_expression ⇒ String

  A cron expression that defines when the scheduled query runs.

• #schedule_start_time ⇒ Integer

  The start time for the query schedule in Unix epoch time (seconds since January 1, 1970, 00:00:00 UTC).

• #start_time_offset ⇒ Integer

  Time offset in seconds from the execution time for the start of the query time range.

• #state ⇒ String

  The initial state of the scheduled query.

• #tags ⇒ Hash<String,String>

  An optional list of key-value pairs to associate with the resource.

• #timezone ⇒ String

  The timezone in which the schedule expression is evaluated.

Instance Attribute Details

#description ⇒ String

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

Returns:

• (String)

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

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_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 destinations where the query results will be delivered after successful execution. You can configure delivery to S3 buckets or EventBridge event buses.

Returns:

• (Types::DestinationConfiguration)

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

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_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 Amazon Resource Name (ARN) of the IAM role that CloudWatch Logs will assume to execute the scheduled query and deliver results to the specified destinations.

Returns:

• (String)

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

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_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>

The log group identifiers to query. You can specify log group names or log group ARNs. If querying log groups in a source account from a monitoring account, you must specify the ARN of the log group.

Returns:

• (Array<String>)

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

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

#name ⇒ String

A unique name for the scheduled query within the region for an AWS account. The name can contain letters, numbers, underscores, hyphens, forward slashes, periods, and hash symbols.

Returns:

• (String)

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

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_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 LogsQL (CloudWatch Logs Insights query language), PPL (OpenSearch Service Piped Processing Language), and SQL (OpenSearch Service Structured Query Language).

Returns:

• (String)

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

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

#query_string ⇒ String

The CloudWatch Logs Insights query string to execute. This is the actual query that will be run against your log data on the specified schedule.

Returns:

• (String)

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

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_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 query schedule in Unix epoch time (seconds since January 1, 1970, 00:00:00 UTC). If not specified, the schedule runs indefinitely.

Returns:

• (Integer)

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

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_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 format is cron(fields) where fields consist of six space-separated values: minutes, hours, day_of_month, month, day_of_week, year.

Returns:

• (String)

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

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_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 query schedule in Unix epoch time (seconds since January 1, 1970, 00:00:00 UTC). If not specified, the schedule starts immediately.

Returns:

• (Integer)

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

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

#start_time_offset ⇒ Integer

Time offset in seconds from the execution time for the start of the query time range. This defines the lookback period for the query (for example, 3600 for the last hour).

Returns:

• (Integer)

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

class CreateScheduledQueryRequest < Struct.new(
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_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 (the query will run according to its schedule) and DISABLED (the query is paused and will not run). If not provided, defaults to ENABLED.

Returns:

• (String)

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

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

#tags ⇒ Hash<String,String>

An optional list of key-value pairs to associate with the resource.

For more information about tagging, see [Tagging Amazon Web Services resources]

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

• (Hash<String,String>)

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

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

#timezone ⇒ String

The timezone in which the schedule expression is evaluated. If not provided, defaults to UTC.

Returns:

• (String)

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

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