Skip to content
v2.274.0

QueryParameterProperty Struct ​

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.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_logs as logs } from 'aws-cdk-lib';
const queryParameterProperty: logs.CfnQueryDefinition.QueryParameterProperty = {
  name: 'name',

  // the properties below are optional
  defaultValue: 'defaultValue',
  description: 'description',
};

Properties ​

defaultValueoptionalstringdefault_valueoptionalstrdefaultValueoptionalStringDefaultValueoptionalstringDefaultValueoptional*string#
The default value to use for this query parameter if no value is supplied at execution time.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the query parameter that explains its purpose or expected values.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the query parameter.

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