interface QueryParameterProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CfnPropertyMixins.AWS.Logs.CfnQueryDefinitionPropsMixin.QueryParameterProperty |
 Go | github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awslogs#CfnQueryDefinitionPropsMixin_QueryParameterProperty |
 Java | software.amazon.awscdk.cfnpropertymixins.services.logs.CfnQueryDefinitionPropsMixin.QueryParameterProperty |
 Python | aws_cdk.cfn_property_mixins.aws_logs.CfnQueryDefinitionPropsMixin.QueryParameterProperty |
 TypeScript | @aws-cdk/cfn-property-mixins » aws_logs » CfnQueryDefinitionPropsMixin » 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/cfn-property-mixins';
const queryParameterProperty: logs.CfnQueryDefinitionPropsMixin.QueryParameterProperty = {
defaultValue: 'defaultValue',
description: 'description',
name: 'name',
};
Properties
| Name | Type | Description |
|---|---|---|
| default | 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? | string | The name of the query parameter. |
defaultValue?
Type:
string
(optional)
The default value to use for this query parameter if no value is supplied at execution time.
description?
Type:
string
(optional)
A description of the query parameter that explains its purpose or expected values.
name?
Type:
string
(optional)
The name of the query parameter.
A query parameter name must start with a letter or underscore, and contain only letters, digits, and underscores.