Package software.amazon.awscdk.services.logs

Interface QueryDefinitionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

QueryDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:44.959Z")
@Stability(Stable)
public interface QueryDefinitionProps
extends software.amazon.jsii.JsiiSerializable

Properties for a QueryDefinition.

Example:

 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	QueryDefinitionProps.Builder	A builder for QueryDefinitionProps
static final class	QueryDefinitionProps.Jsii$Proxy	An implementation for QueryDefinitionProps

Method Summary

Modifier and Type	Method	Description
static QueryDefinitionProps.Builder	builder()
default List<ILogGroup>	getLogGroups()	Specify certain log groups for the query definition.
String	getQueryDefinitionName()	Name of the query definition.
QueryString	getQueryString()	The query string to use for this query definition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getQueryDefinitionName

@Stability(Stable)
@NotNull
String getQueryDefinitionName()

Name of the query definition.

getQueryString

@Stability(Stable)
@NotNull
QueryString getQueryString()

The query string to use for this query definition.

getLogGroups

@Stability(Stable)
@Nullable
default List<ILogGroup> getLogGroups()

Specify certain log groups for the query definition.

Default: - no specified log groups

builder

@Stability(Stable)
static QueryDefinitionProps.Builder builder()

Returns:

a QueryDefinitionProps.Builder of QueryDefinitionProps