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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:38.133Z")
@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"))
                 .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()	Filters the results of a query that's based on one or more conditions.
default Number	getLimit()	Specifies the number of log events returned by the query.
default String	getParse()	Extracts data from a log field and creates one or more ephemeral fields that you can process 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(Stable)
@Nullable
default String getFilter()

Filters the results of a query that's based on one or more conditions.

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(Stable)
@Nullable
default String getParse()

Extracts data from a log field and creates one or more ephemeral fields that you can process further in the query.

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