class Amazonite::CloudWatchLogs::QueryParameter

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.

Included Modules

Defined in:

cloudwatch_logs/query_parameter.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(name : String, default_value : String | Nil = nil, description : String | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def default_value : String | Nil #

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


[View source]
def default_value=(default_value : String | Nil) #

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


[View source]
def description : String | Nil #

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


[View source]
def description=(description : String | Nil) #

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


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def 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.


[View source]
def name=(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.


[View source]
def validate! : Nil #

[View source]