AWS::Logs::QueryDefinition QueryParameter - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Logs::QueryDefinition 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.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "DefaultValue" : String,
  "Description" : String,
  "Name" : String
}

YAML

  DefaultValue: String
  Description: String
  Name: String

Properties

DefaultValue

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

Required: No

Type: String

Maximum: 1024

Update requires: No interruption

Description

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

Required: No

Type: String

Maximum: 512

Update requires: No interruption

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.

Required: Yes

Type: String

Pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$

Maximum: 128

Update requires: No interruption