Class: Aws::CloudWatchLogs::Types::QueryParameter

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchLogs::Types::QueryParameter

Includes:

Structure

Defined in:

lib/aws-sdk-cloudwatchlogs/types.rb

Overview

This structure defines a query parameter for a saved CloudWatch Logs Insights query definition. Query parameters are supported only for Logs Insights QL queries. They are placeholder variables that you can reference in a query string using the ‘{parameterName}` syntax. Each parameter can include a default value and a description.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #default_value ⇒ String

  The default value to use for this query parameter if no value is supplied at execution time.

• #description ⇒ String

  A description of the query parameter that explains its purpose or expected values.

• #name ⇒ String

  The name of the query parameter.

Instance Attribute Details

#default_value ⇒ String

The default value to use for this query parameter if no value is supplied at execution time.

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

class QueryParameter < Struct.new(
  :name,
  :default_value,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the query parameter that explains its purpose or expected values.

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

class QueryParameter < Struct.new(
  :name,
  :default_value,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the query parameter. A query parameter name must start with a letter or underscore, and contain only letters, digits, and underscores.

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

class QueryParameter < Struct.new(
  :name,
  :default_value,
  :description)
  SENSITIVE = []
  include Aws::Structure
end