Skip to content
v2.277.0

QueryStringProps Struct ​

Properties for a QueryString.

Example ​

ts
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,
  }),
});
python
logs.QueryDefinition(self, "QueryDefinition",
    query_definition_name="MyQuery",
    query_string=logs.QueryString(
        fields=["@timestamp", "@message"],
        parse_statements=["@message \"[*] *\" as loggingType, loggingMessage", "@message \"<*>: *\" as differentLoggingType, differentLoggingMessage"
        ],
        filter_statements=["loggingType = \"ERROR\"", "loggingMessage = \"A very strange error occurred!\""
        ],
        stats_statements=["count(loggingMessage) as loggingErrors", "count(differentLoggingMessage) as differentLoggingErrors"
        ],
        sort="@timestamp desc",
        limit=20
    )
)
java
QueryDefinition.Builder.create(this, "QueryDefinition")
        .queryDefinitionName("MyQuery")
        .queryString(QueryString.Builder.create()
                .fields(List.of("@timestamp", "@message"))
                .parseStatements(List.of("@message \"[*] *\" as loggingType, loggingMessage", "@message \"<*>: *\" as differentLoggingType, differentLoggingMessage"))
                .filterStatements(List.of("loggingType = \"ERROR\"", "loggingMessage = \"A very strange error occurred!\""))
                .statsStatements(List.of("count(loggingMessage) as loggingErrors", "count(differentLoggingMessage) as differentLoggingErrors"))
                .sort("@timestamp desc")
                .limit(20)
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
new QueryDefinition(this, "QueryDefinition", new QueryDefinitionProps {
    QueryDefinitionName = "MyQuery",
    QueryString = new QueryString(new QueryStringProps {
        Fields = new [] { "@timestamp", "@message" },
        ParseStatements = new [] { "@message \"[*] *\" as loggingType, loggingMessage", "@message \"<*>: *\" as differentLoggingType, differentLoggingMessage" },
        FilterStatements = new [] { "loggingType = \"ERROR\"", "loggingMessage = \"A very strange error occurred!\"" },
        StatsStatements = new [] { "count(loggingMessage) as loggingErrors", "count(differentLoggingMessage) as differentLoggingErrors" },
        Sort = "@timestamp desc",
        Limit = 20
    })
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
logs.NewQueryDefinition(this, jsii.String("QueryDefinition"), &QueryDefinitionProps{
	QueryDefinitionName: jsii.String("MyQuery"),
	QueryString: logs.NewQueryString(&QueryStringProps{
		Fields: []*string{
			jsii.String("@timestamp"),
			jsii.String("@message"),
		},
		ParseStatements: []*string{
			jsii.String("@message \"[*] *\" as loggingType, loggingMessage"),
			jsii.String("@message \"<*>: *\" as differentLoggingType, differentLoggingMessage"),
		},
		FilterStatements: []*string{
			jsii.String("loggingType = \"ERROR\""),
			jsii.String("loggingMessage = \"A very strange error occurred!\""),
		},
		StatsStatements: []*string{
			jsii.String("count(loggingMessage) as loggingErrors"),
			jsii.String("count(differentLoggingMessage) as differentLoggingErrors"),
		},
		Sort: jsii.String("@timestamp desc"),
		Limit: jsii.Number(20),
	}),
})

Properties ​

displayoptionalstringdisplayoptionalstrdisplayoptionalStringDisplayoptionalstringDisplayoptional*string#
Specifies which fields to display in the query results.

Default: no display in QueryString

fieldsoptionalstring[]fieldsoptionaltyping.List[str]fieldsoptionalList<String>Fieldsoptionalstring[]Fieldsoptional*[]*string#
Retrieves the specified fields from log events for display.

Default: no fields in QueryString

filteroptionalstringfilteroptionalstrfilteroptionalStringFilteroptionalstringFilteroptional*stringdeprecated#
Use `filterStatements` instead

Default: no filter in QueryString

filterStatementsoptionalstring[]filter_statementsoptionaltyping.List[str]filterStatementsoptionalList<String>FilterStatementsoptionalstring[]FilterStatementsoptional*[]*string#
An array of one or more statements for filtering the results of a query based on a boolean expression.

Default: no filter in QueryString

Each provided statement generates a separate filter line in the query string.

Note: If provided, this property overrides any value provided for the filter property.

limitoptionalnumberlimitoptionalint | floatlimitoptionalNumberLimitoptionaldoubleLimitoptional*float64#
Specifies the number of log events returned by the query.

Default: no limit in QueryString

parseoptionalstringparseoptionalstrparseoptionalStringParseoptionalstringParseoptional*stringdeprecated#
Use `parseStatements` instead

Default: no parse in QueryString

parseStatementsoptionalstring[]parse_statementsoptionaltyping.List[str]parseStatementsoptionalList<String>ParseStatementsoptionalstring[]ParseStatementsoptional*[]*string#
An array of one or more statements for parsing data from a log field and creating ephemeral fields that can be processed further in the query.

Default: no parse in QueryString

Each provided statement generates a separate parse line in the query string.

Note: If provided, this property overrides any value provided for the parse property.

sortoptionalstringsortoptionalstrsortoptionalStringSortoptionalstringSortoptional*string#
Sorts the retrieved log events.

Default: no sort in QueryString

statsoptionalstringstatsoptionalstrstatsoptionalStringStatsoptionalstringStatsoptional*stringdeprecated#
Use `statsStatements` instead

Default: no stats in QueryString

statsStatementsoptionalstring[]stats_statementsoptionaltyping.List[str]statsStatementsoptionalList<String>StatsStatementsoptionalstring[]StatsStatementsoptional*[]*string#
An array of one or more statements for calculating aggregate statistics.

Default: no stats in QueryString

notes

CloudWatch Logs Insights supports up to two stats commands in a single query. Each provided statement generates a separate stats line in the query string.

Note: If provided, this property overrides any value provided for the stats property.