Class: Aws::CloudWatchLogs::Types::PutQueryDefinitionRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchLogs::Types::PutQueryDefinitionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cloudwatchlogs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.

• #log_group_names ⇒ Array<String>

  Use this parameter to include specific log groups as part of your query definition.

• #name ⇒ String

  A name for the query definition.

• #query_definition_id ⇒ String

  If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update.

• #query_language ⇒ String

  Specify the query language to use for this query.

• #query_string ⇒ String

  The query string to use for this definition.

Instance Attribute Details

#client_token ⇒ String

Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

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

class PutQueryDefinitionRequest < Struct.new(
  :query_language,
  :name,
  :query_definition_id,
  :log_group_names,
  :query_string,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_names ⇒ Array<String>

Use this parameter to include specific log groups as part of your query definition. If your query uses the OpenSearch Service query language, you specify the log group names inside the ‘querystring` instead of here.

If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL and you omit this parameter, then the updated definition will contain no log groups.

Returns:

• (Array<String>)

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

class PutQueryDefinitionRequest < Struct.new(
  :query_language,
  :name,
  :query_definition_id,
  :log_group_names,
  :query_string,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the ‘queryDefinitionNamePrefix` parameter of [DescribeQueryDefinitions].

[1]: docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html

Returns:

• (String)

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

class PutQueryDefinitionRequest < Struct.new(
  :query_language,
  :name,
  :query_definition_id,
  :log_group_names,
  :query_string,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#query_definition_id ⇒ String

If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use [DescribeQueryDefinitions] to retrieve the IDs of your saved query definitions.

If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

[1]: docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html

Returns:

• (String)

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

class PutQueryDefinitionRequest < Struct.new(
  :query_language,
  :name,
  :query_definition_id,
  :log_group_names,
  :query_string,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#query_language ⇒ String

Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see [Supported query languages].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html

Returns:

• (String)

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

class PutQueryDefinitionRequest < Struct.new(
  :query_language,
  :name,
  :query_definition_id,
  :log_group_names,
  :query_string,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#query_string ⇒ String

The query string to use for this definition. For more information, see [CloudWatch Logs Insights Query Syntax].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html

Returns:

• (String)

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

class PutQueryDefinitionRequest < Struct.new(
  :query_language,
  :name,
  :query_definition_id,
  :log_group_names,
  :query_string,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end