QueryParameter
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.
Contents
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z_][a-zA-Z0-9_]*Required: Yes
- defaultValue
-
The default value to use for this query parameter if no value is supplied at execution time.
Type: String
Length Constraints: Maximum length of 1024.
Required: No
- description
-
A description of the query parameter that explains its purpose or expected values.
Type: String
Length Constraints: Maximum length of 512.
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: