Skip to content

/AWS1/CL_CWLQUERYPARAMETER

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.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_name TYPE /AWS1/CWLQUERYPARAMETERNAME /AWS1/CWLQUERYPARAMETERNAME

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

Optional arguments:

iv_defaultvalue TYPE /AWS1/CWLQUERYPARAMDEFVALUE /AWS1/CWLQUERYPARAMDEFVALUE

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

iv_description TYPE /AWS1/CWLQUERYPARAMETERDESC /AWS1/CWLQUERYPARAMETERDESC

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


Queryable Attributes

name

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

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

defaultValue

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

Accessible with the following methods

Method Description
GET_DEFAULTVALUE() Getter for DEFAULTVALUE, with configurable default
ASK_DEFAULTVALUE() Getter for DEFAULTVALUE w/ exceptions if field has no value
HAS_DEFAULTVALUE() Determine if DEFAULTVALUE has a value

description

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

Accessible with the following methods

Method Description
GET_DESCRIPTION() Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION() Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION() Determine if DESCRIPTION has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_QUERYPARAMETERLIST

TYPES TT_QUERYPARAMETERLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_CWLQUERYPARAMETER WITH DEFAULT KEY
.