| 1 | import { Resource } from '@aws-cdk/core';
|
| 2 | import { Construct } from 'constructs';
|
| 3 | import { ILogGroup } from './log-group';
|
| 4 | /**
|
| 5 | * Properties for a QueryString
|
| 6 | */
|
| 7 | export interface QueryStringProps {
|
| 8 | /**
|
| 9 | * Retrieves the specified fields from log events for display.
|
| 10 | *
|
| 11 | * @default - no fields in QueryString
|
| 12 | */
|
| 13 | readonly fields?: string[];
|
| 14 | /**
|
| 15 | * Extracts data from a log field and creates one or more ephemeral fields that you can process further in the query.
|
| 16 | *
|
| 17 | * @default - no parse in QueryString
|
| 18 | */
|
| 19 | readonly parse?: string;
|
| 20 | /**
|
| 21 | * Filters the results of a query that's based on one or more conditions.
|
| 22 | *
|
| 23 | * @default - no filter in QueryString
|
| 24 | */
|
| 25 | readonly filter?: string;
|
| 26 | /**
|
| 27 | * Uses log field values to calculate aggregate statistics.
|
| 28 | *
|
| 29 | * @default - no stats in QueryString
|
| 30 | */
|
| 31 | readonly stats?: string;
|
| 32 | /**
|
| 33 | * Sorts the retrieved log events.
|
| 34 | *
|
| 35 | * @default - no sort in QueryString
|
| 36 | */
|
| 37 | readonly sort?: string;
|
| 38 | /**
|
| 39 | * Specifies the number of log events returned by the query.
|
| 40 | *
|
| 41 | * @default - no limit in QueryString
|
| 42 | */
|
| 43 | readonly limit?: Number;
|
| 44 | /**
|
| 45 | * Specifies which fields to display in the query results.
|
| 46 | *
|
| 47 | * @default - no display in QueryString
|
| 48 | */
|
| 49 | readonly display?: string;
|
| 50 | }
|
| 51 | /**
|
| 52 | * Define a QueryString
|
| 53 | */
|
| 54 | export declare class QueryString {
|
| 55 | private readonly fields?;
|
| 56 | private readonly parse?;
|
| 57 | private readonly filter?;
|
| 58 | private readonly stats?;
|
| 59 | private readonly sort?;
|
| 60 | private readonly limit?;
|
| 61 | private readonly display?;
|
| 62 | constructor(props?: QueryStringProps);
|
| 63 | /**
|
| 64 | * String representation of this QueryString.
|
| 65 | */
|
| 66 | toString(): string;
|
| 67 | }
|
| 68 | /**
|
| 69 | * Properties for a QueryDefinition
|
| 70 | */
|
| 71 | export interface QueryDefinitionProps {
|
| 72 | /**
|
| 73 | * Name of the query definition.
|
| 74 | */
|
| 75 | readonly queryDefinitionName: string;
|
| 76 | /**
|
| 77 | * The query string to use for this query definition.
|
| 78 | */
|
| 79 | readonly queryString: QueryString;
|
| 80 | /**
|
| 81 | * Specify certain log groups for the query definition.
|
| 82 | *
|
| 83 | * @default - no specified log groups
|
| 84 | */
|
| 85 | readonly logGroups?: ILogGroup[];
|
| 86 | }
|
| 87 | /**
|
| 88 | * Define a query definition for CloudWatch Logs Insights
|
| 89 | */
|
| 90 | export declare class QueryDefinition extends Resource {
|
| 91 | /**
|
| 92 | * The ID of the query definition.
|
| 93 | *
|
| 94 | * @attribute
|
| 95 | */
|
| 96 | readonly queryDefinitionId: string;
|
| 97 | constructor(scope: Construct, id: string, props: QueryDefinitionProps);
|
| 98 | }
|