class QueryDefinition (construct)

Language	Type name
.NET	Amazon.CDK.AWS.Logs.QueryDefinition
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslogs#QueryDefinition
Java	software.amazon.awscdk.services.logs.QueryDefinition
Python	aws_cdk.aws_logs.QueryDefinition
TypeScript (source)	aws-cdk-lib » aws_logs » QueryDefinition

Implements IConstruct, IDependable, IResource, IEnvironmentAware

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!"',
    ],
    statsStatements: [
      'count(loggingMessage) as loggingErrors',
      'count(differentLoggingMessage) as differentLoggingErrors',
    ],
    sort: '@timestamp desc',
    limit: 20,
  }),
});

Initializer

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

Parameters

• scope Construct
• id string
• props QueryDefinitionProps

Construct Props

Name	Type	Description
queryDefinitionName	string	Name of the query definition.
queryString	QueryString	The 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

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
queryDefinitionId	string	The ID of the query definition.
stack	Stack	The stack in which this resource is defined.
static PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they 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.

---

static PROPERTY_INJECTION_ID

Type: string

Uniquely identifies this class.

Methods

Name	Description
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.