interface CfnQueryDefinitionProps

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

Properties for defining a CfnQueryDefinition.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_logs as logs } from 'aws-cdk-lib';
const cfnQueryDefinitionProps: logs.CfnQueryDefinitionProps = {
  name: 'name',
  queryString: 'queryString',

  // the properties below are optional
  logGroupNames: ['logGroupNames'],
  queryLanguage: 'queryLanguage',
};

Properties

Name	Type	Description
name	string	A name for the query definition.
queryString	string	The query string to use for this query definition.
logGroupNames?	string[]	Use this parameter if you want the query to query only certain log groups.
queryLanguage?	string	The query language used for this query.

---

name

Type: string

A name for the query definition.

You can use the name to create a folder structure for your queries. To create a folder, use a forward slash (/) to prefix your desired query name with your desired folder name. For example, *folder-name* / *query-name* .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-name

---

queryString

Type: string

The query string to use for this query definition.

For more information, see CloudWatch Logs Insights Query Syntax .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-querystring

---

logGroupNames?

Type: string[] (optional)

Use this parameter if you want the query to query only certain log groups.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-loggroupnames

---

queryLanguage?

Type: string (optional, default: "CWLI")

The query language used for this query.

For more information about the query languages that CloudWatch Logs supports, see Supported query languages .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-querylanguage