Package software.amazon.awscdk.services.logs

Interface QueryStringProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

QueryStringProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:33.819Z")
@Stability(Stable)
public interface QueryStringProps
extends software.amazon.jsii.JsiiSerializable

Properties for a QueryString.

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!\""))
                 .sort("@timestamp desc")
                 .limit(20)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static QueryStringProps.Builder	builder()
default String	getDisplay()	Specifies which fields to display in the query results.
default List<String>	getFields()	Retrieves the specified fields from log events for display.
default String	getFilter()	Deprecated. Use filterStatements instead
default List<String>	getFilterStatements()	An array of one or more statements for filtering the results of a query based on a boolean expression.
default Number	getLimit()	Specifies the number of log events returned by the query.
default String	getParse()	Deprecated. Use parseStatements instead
default List<String>	getParseStatements()	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 String	getSort()	Sorts the retrieved log events.
default String	getStats()	Uses log field values to calculate aggregate statistics.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDisplay

@Stability(Stable)
@Nullable
default String getDisplay()

Specifies which fields to display in the query results.

Default: - no display in QueryString

getFields

@Stability(Stable)
@Nullable
default List<String> getFields()

Retrieves the specified fields from log events for display.

Default: - no fields in QueryString

getFilter

@Stability(Deprecated)
@Deprecated
@Nullable
default String getFilter()

Deprecated.

Use filterStatements instead

(deprecated) A single statement for filtering the results of a query based on a boolean expression.

Default: - no filter in QueryString

getFilterStatements

@Stability(Stable)
@Nullable
default List<String> getFilterStatements()

An array of one or more statements for filtering the results of a query based on a boolean expression.

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.

Default: - no filter in QueryString

getLimit

@Stability(Stable)
@Nullable
default Number getLimit()

Specifies the number of log events returned by the query.

Default: - no limit in QueryString

getParse

@Stability(Deprecated)
@Deprecated
@Nullable
default String getParse()

Deprecated.

Use parseStatements instead

(deprecated) A single statement for parsing data from a log field and creating ephemeral fields that can be processed further in the query.

Default: - no parse in QueryString

getParseStatements

@Stability(Stable)
@Nullable
default List<String> getParseStatements()

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.

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.

Default: - no parse in QueryString

getSort

@Stability(Stable)
@Nullable
default String getSort()

Sorts the retrieved log events.

Default: - no sort in QueryString

getStats

@Stability(Stable)
@Nullable
default String getStats()

Uses log field values to calculate aggregate statistics.

Default: - no stats in QueryString

builder

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

Returns:

a QueryStringProps.Builder of QueryStringProps