Class: Aws::CloudWatchLogs::Types::UpdateScheduledQueryRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchLogs::Types::UpdateScheduledQueryRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cloudwatchlogs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  Updated description for the scheduled query.

• #destination_configuration ⇒ Types::DestinationConfiguration

  Updated configuration for destinations where the query results will be delivered.

• #execution_role_arn ⇒ String

  Updated ARN of the IAM role that CloudWatch Logs will assume to execute the scheduled query.

• #identifier ⇒ String

  The name or ARN of the scheduled query to update.

• #log_group_identifiers ⇒ Array<String>

  Updated log group identifiers to query.

• #query_language ⇒ String

  Updated query language to use (LogsQL, PPL, or SQL).

• #query_string ⇒ String

  Updated CloudWatch Logs Insights query string to execute.

• #schedule_end_time ⇒ Integer

  Updated end time for the query schedule in Unix epoch time.

• #schedule_expression ⇒ String

  Updated cron expression that defines when the scheduled query runs.

• #schedule_start_time ⇒ Integer

  Updated start time for the query schedule in Unix epoch time.

• #start_time_offset ⇒ Integer

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

• #state ⇒ String

  Updated state of the scheduled query (ENABLED or DISABLED).

• #timezone ⇒ String

  Updated timezone in which the schedule expression is evaluated.

Instance Attribute Details

#description ⇒ String

Updated description for the scheduled query.

Returns:

• (String)

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

class UpdateScheduledQueryRequest < Struct.new(
  :identifier,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#destination_configuration ⇒ Types::DestinationConfiguration

Updated configuration for destinations where the query results will be delivered.

Returns:

• (Types::DestinationConfiguration)

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

class UpdateScheduledQueryRequest < Struct.new(
  :identifier,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arn ⇒ String

Updated ARN of the IAM role that CloudWatch Logs will assume to execute the scheduled query.

Returns:

• (String)

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

class UpdateScheduledQueryRequest < Struct.new(
  :identifier,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#identifier ⇒ String

The name or ARN of the scheduled query to update.

Returns:

• (String)

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

class UpdateScheduledQueryRequest < Struct.new(
  :identifier,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_identifiers ⇒ Array<String>

Updated log group identifiers to query.

Returns:

• (Array<String>)

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

class UpdateScheduledQueryRequest < Struct.new(
  :identifier,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#query_language ⇒ String

Updated query language to use (LogsQL, PPL, or SQL).

Returns:

• (String)

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

class UpdateScheduledQueryRequest < Struct.new(
  :identifier,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#query_string ⇒ String

Updated CloudWatch Logs Insights query string to execute.

Returns:

• (String)

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

class UpdateScheduledQueryRequest < Struct.new(
  :identifier,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_end_time ⇒ Integer

Updated end time for the query schedule in Unix epoch time.

Returns:

• (Integer)

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

class UpdateScheduledQueryRequest < Struct.new(
  :identifier,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression ⇒ String

Updated cron expression that defines when the scheduled query runs.

Returns:

• (String)

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

class UpdateScheduledQueryRequest < Struct.new(
  :identifier,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_start_time ⇒ Integer

Updated start time for the query schedule in Unix epoch time.

Returns:

• (Integer)

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

class UpdateScheduledQueryRequest < Struct.new(
  :identifier,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#start_time_offset ⇒ Integer

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

Returns:

• (Integer)

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

class UpdateScheduledQueryRequest < Struct.new(
  :identifier,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

Updated state of the scheduled query (ENABLED or DISABLED).

Returns:

• (String)

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

class UpdateScheduledQueryRequest < Struct.new(
  :identifier,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#timezone ⇒ String

Updated timezone in which the schedule expression is evaluated.

Returns:

• (String)

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

class UpdateScheduledQueryRequest < Struct.new(
  :identifier,
  :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)
  SENSITIVE = []
  include Aws::Structure
end