QueryString

class aws_cdk.aws_logs.QueryString(*, display=None, fields=None, filter=None, filter_statements=None, limit=None, parse=None, parse_statements=None, sort=None, stats=None, stats_statements=None)

Bases: object

Define a QueryString.

ExampleMetadata:: infused

Example:

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

Parameters:

display (Optional[str]) – Specifies which fields to display in the query results. Default: - no display in QueryString
fields (Optional[Sequence[str]]) – Retrieves the specified fields from log events for display. Default: - no fields in QueryString
filter (Optional[str]) – (deprecated) A single statement for filtering the results of a query based on a boolean expression. Default: - no filter in QueryString
filter_statements (Optional[Sequence[str]]) – 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
limit (Union[int, float, None]) – Specifies the number of log events returned by the query. Default: - no limit in QueryString
parse (Optional[str]) – (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
parse_statements (Optional[Sequence[str]]) – 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
sort (Optional[str]) – Sorts the retrieved log events. Default: - no sort in QueryString
stats (Optional[str]) – (deprecated) A single statement for using log field values to calculate aggregate statistics. Default: - no stats in QueryString
stats_statements (Optional[Sequence[str]]) – An array of one or more statements for calculating aggregate statistics. 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. Default: - no stats in QueryString

Methods

to_string()

String representation of this QueryString.

Return type:: str

Attributes

has_stats_and_stats_statements: If the props for the query string have both stats and statsStatements.

stats_statements_length: Length of statsStatements.