aws-cdk-lib.aws_logs.QueryDefinition

class QueryDefinition (construct)

LanguageType name
.NETAmazon.CDK.AWS.Logs.QueryDefinition
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslogs#QueryDefinition
Javasoftware.amazon.awscdk.services.logs.QueryDefinition
Pythonaws_cdk.aws_logs.QueryDefinition
TypeScript (source)aws-cdk-lib » aws_logs » QueryDefinition

Implements IConstruct, IDependable, IResource

Define a query definition for CloudWatch Logs Insights.

Example

new logs.QueryDefinition(this, 'QueryDefinition', {
  queryDefinitionName: 'MyQuery',
  queryString: new logs.QueryString({
    fields: ['@timestamp', '@message'],
    parseStatements: [
      '@message "[*] *" as loggingType, loggingMessage',
      '@message "<*>: *" as differentLoggingType, differentLoggingMessage',
    ],
    filterStatements: [
      'loggingType = "ERROR"',
      'loggingMessage = "A very strange error occurred!"',
    ],
    sort: '@timestamp desc',
    limit: 20,
  }),
});

Initializer

new QueryDefinition(scope: Construct, id: string, props: QueryDefinitionProps)

Parameters

  • scope Construct
  • id string
  • props QueryDefinitionProps

Construct Props

NameTypeDescription
queryDefinitionNamestringName of the query definition.
queryStringQueryStringThe query string to use for this query definition.
logGroups?ILogGroup[]Specify certain log groups for the query definition.

queryDefinitionName

Type: string

Name of the query definition.


queryString

Type: QueryString

The query string to use for this query definition.


logGroups?

Type: ILogGroup[] (optional, default: no specified log groups)

Specify certain log groups for the query definition.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
queryDefinitionIdstringThe ID of the query definition.
stackStackThe stack in which this resource is defined.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node

Type: Node

The tree node.


queryDefinitionId

Type: string

The ID of the query definition.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.