aws-cdk-lib.aws_logs.QueryDefinitionProps

QueryDefinitionProps Struct

Properties for a QueryDefinition.

QueryDefinitionProps

used as props by

• QueryDefinition

Source

aws-logs/lib/query-definition.ts

Type last changed

v2.235.0 · 15 Jan 2026

Example

new logs.QueryDefinition(this, 'QueryDefinition', {
  queryDefinitionName: 'MyQuery',
  queryString: new logs.QueryString({
    fields: ['@timestamp', '@message'],
    parseStatements: [
      '@message "[*] *" as loggingType, loggingMessage',
      '@message "<*>: *" as differentLoggingType, differentLoggingMessage',
    ],
    filterStatements: [
      'loggingType = "ERROR"',
      'loggingMessage = "A very strange error occurred!"',
    ],
    statsStatements: [
      'count(loggingMessage) as loggingErrors',
      'count(differentLoggingMessage) as differentLoggingErrors',
    ],
    sort: '@timestamp desc',
    limit: 20,
  }),
});

Properties

logGroups?optionalILogGroupRef[]log_groups?optionaltyping.List[ILogGroupRef]logGroups?optionalList<ILogGroupRef>LogGroups?optionalILogGroupRef[]LogGroups?optional*[]ILogGroupRef#

Specify certain log groups for the query definition.

Default: no specified log groups

queryDefinitionNamestringquery_definition_namestrqueryDefinitionNameStringQueryDefinitionNamestringQueryDefinitionName*stringrequired#

Name of the query definition.

queryStringQueryStringquery_stringQueryStringqueryStringQueryStringQueryStringQueryStringQueryStringQueryStringrequired#

The query string to use for this query definition.