interface QueryParameterProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Logs.CfnQueryDefinition.QueryParameterProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awslogs#CfnQueryDefinition_QueryParameterProperty`
Java	`software.amazon.awscdk.services.logs.CfnQueryDefinition.QueryParameterProperty`
Python	`aws_cdk.aws_logs.CfnQueryDefinition.QueryParameterProperty`
TypeScript	`aws-cdk-lib` » `aws_logs` » `CfnQueryDefinition` » `QueryParameterProperty`

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

// 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

Name	Type	Description
name	`string`	The name of the query parameter.
defaultValue?	`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

Type: 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.

defaultValue?

Type: string (optional)

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

description?