feat(cloudwatch-dashboards): add support for queryLanguage property (#34547)

### Issue # (if applicable)

Closes #34482

### Reason for this change

CloudWatch [recently added support for using multiple query languages to query logs](https://aws.amazon.com/blogs/aws/new-amazon-cloudwatch-and-amazon-opensearch-service-launch-an-integrated-analytics-experience/). Currently, CDK is missing the functionality to specify a query language when creating a Log Query Widget inside a CloudWatch Dashboard.

### Description of changes

Applied [suggested implementation](#34482 (comment)) by @ykethan and added tests.

### Describe any new or updated permissions being added

N/A

### Description of how you validated changes

Added unit test and updated integ test.

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: CDillinger

packages/@aws-cdk-testing/framework-integ/test/aws-cloudwatch/test/integ.alarm-and-dashboard.js.snapshot/aws-cdk-cloudwatch-alarms.assets.json

@@ -94,7 +94,15 @@
        {
         "Ref": "AWS::Region"
        },
-       "\",\"accountId\":\"123456789012\",\"query\":\"SOURCE 'my-log-group' | fields @message\\n                | filter @message like /Error/\"}},{\"type\":\"metric\",\"width\":6,\"height\":3,\"x\":0,\"y\":50,\"properties\":{\"view\":\"singleValue\",\"title\":\"Sent message size\",\"region\":\"",
+       "\",\"accountId\":\"123456789012\",\"query\":\"SOURCE 'my-log-group' | fields @message\\n                | filter @message like /Error/\"}},{\"type\":\"log\",\"width\":6,\"height\":6,\"x\":0,\"y\":50,\"properties\":{\"view\":\"table\",\"title\":\"Errors in my log group - SQL\",\"region\":\"",
+       {
+        "Ref": "AWS::Region"
+       },
+       "\",\"query\":\"SOURCE 'my-log-group' | SELECT count(*) as count FROM 'my-log-group'\",\"queryLanguage\":\"SQL\"}},{\"type\":\"log\",\"width\":6,\"height\":6,\"x\":0,\"y\":56,\"properties\":{\"view\":\"table\",\"title\":\"Errors in my log group - PPL\",\"region\":\"",
+       {
+        "Ref": "AWS::Region"
+       },
+       "\",\"query\":\"SOURCE 'my-log-group' | fields `@message` | sort - `@timestamp`\",\"queryLanguage\":\"PPL\"}},{\"type\":\"metric\",\"width\":6,\"height\":3,\"x\":0,\"y\":62,\"properties\":{\"view\":\"singleValue\",\"title\":\"Sent message size\",\"region\":\"",
        {
         "Ref": "AWS::Region"
        },
@@ -105,7 +113,7 @@
          "QueueName"
         ]
        },
-       "\"]],\"singleValueFullPrecision\":false}},{\"type\":\"metric\",\"width\":6,\"height\":3,\"x\":0,\"y\":53,\"properties\":{\"view\":\"singleValue\",\"title\":\"Sent message size with full precision\",\"region\":\"",
+       "\"]],\"singleValueFullPrecision\":false}},{\"type\":\"metric\",\"width\":6,\"height\":3,\"x\":0,\"y\":65,\"properties\":{\"view\":\"singleValue\",\"title\":\"Sent message size with full precision\",\"region\":\"",
        {
         "Ref": "AWS::Region"
        },
@@ -116,7 +124,7 @@
          "QueueName"
         ]
        },
-       "\"]],\"singleValueFullPrecision\":true}},{\"type\":\"custom\",\"width\":6,\"height\":6,\"x\":0,\"y\":56,\"properties\":{\"endpoint\":\"arn:aws:lambda:us-west-2:123456789012:function:my-function\",\"title\":\"My custom alarm\",\"updateOn\":{\"refresh\":true,\"resize\":true,\"timeRange\":true}}}]}"
+       "\"]],\"singleValueFullPrecision\":true}},{\"type\":\"custom\",\"width\":6,\"height\":6,\"x\":0,\"y\":68,\"properties\":{\"endpoint\":\"arn:aws:lambda:us-west-2:123456789012:function:my-function\",\"title\":\"My custom alarm\",\"updateOn\":{\"refresh\":true,\"resize\":true,\"timeRange\":true}}}]}"
       ]
      ]
     },

packages/@aws-cdk-testing/framework-integ/test/aws-cloudwatch/test/integ.alarm-and-dashboard.js.snapshot/aws-cdk-cloudwatch-alarms.template.json

@@ -94,6 +94,18 @@ dashboard.addWidgets(new cloudwatch.LogQueryWidget({
                 | filter @message like /Error/`,
   accountId: '123456789012',
 }));
+dashboard.addWidgets(new cloudwatch.LogQueryWidget({
+  title: 'Errors in my log group - SQL',
+  logGroupNames: ['my-log-group'],
+  queryString: "SELECT count(*) as count FROM 'my-log-group'",
+  queryLanguage: cloudwatch.LogQueryLanguage.SQL,
+}));
+dashboard.addWidgets(new cloudwatch.LogQueryWidget({
+  title: 'Errors in my log group - PPL',
+  logGroupNames: ['my-log-group'],
+  queryString: 'fields `@message`\ | sort - `@timestamp`',
+  queryLanguage: cloudwatch.LogQueryLanguage.PPL,
+}));
 dashboard.addWidgets(new cloudwatch.SingleValueWidget({
   title: 'Sent message size',
   metrics: [sentMessageSizeMetric],

packages/@aws-cdk-testing/framework-integ/test/aws-cloudwatch/test/integ.alarm-and-dashboard.js.snapshot/integ.json

@@ -848,6 +848,19 @@ dashboard.addWidgets(new cloudwatch.LogQueryWidget({
 }));
 ```
 
+Log Insights QL is the default query language. You may specify an [alternate query language: OpenSearch PPL or SQL](https://aws.amazon.com/blogs/aws/new-amazon-cloudwatch-and-amazon-opensearch-service-launch-an-integrated-analytics-experience/), if desired:
+
+```ts
+declare const dashboard: cloudwatch.Dashboard;
+
+dashboard.addWidgets(new cloudwatch.LogQueryWidget({
+  logGroupNames: ['my-log-group'],
+  view: cloudwatch.LogQueryVisualizationType.TABLE,
+  queryString: "SELECT count(*) as count FROM 'my-log-group'",
+  queryLanguage: cloudwatch.LogQueryLanguage.SQL,
+}));
+```
+
 ### Custom widget
 
 A `CustomWidget` shows the result of an AWS Lambda function:

packages/@aws-cdk-testing/framework-integ/test/aws-cloudwatch/test/integ.alarm-and-dashboard.js.snapshot/manifest.json

@@ -26,6 +26,17 @@ export enum LogQueryVisualizationType {
    */
   PIE = 'pie',
 }
+/**
+ * Logs Query Language
+ */
+export enum LogQueryLanguage {
+  /** Logs Insights QL */
+  LOGS_INSIGHTS = 'Logs',
+  /** OpenSearch SQL */
+  SQL = 'SQL',
+  /** OpenSearch PPL */
+  PPL = 'PPL',
+}
 
 /**
  * Properties for a Query widget
@@ -62,6 +73,12 @@ export interface LogQueryWidgetProps {
    */
   readonly queryLines?: string[];
 
+  /**
+   * The query language to use for the query.
+   * @default LogQueryLanguage.LOGS_INSIGHTS
+   */
+  readonly queryLanguage?: LogQueryLanguage;
+
   /**
    * The region the metrics of this widget should be taken from
    *
@@ -124,22 +141,26 @@ export class LogQueryWidget extends ConcreteWidget {
       throw new cdk.UnscopedValidationError('Specify exactly one of \'queryString\' and \'queryLines\'');
     }
   }
-
   public toJson(): any[] {
     const sources = this.props.logGroupNames.map(l => `SOURCE '${l}'`).join(' | ');
     const query = this.props.queryLines
       ? this.props.queryLines.join('\n| ')
       : this.props.queryString;
 
     const properties: any = {
-      view: this.props.view? this.props.view : LogQueryVisualizationType.TABLE,
+      view: this.props.view ? this.props.view : LogQueryVisualizationType.TABLE,
       title: this.props.title,
       region: this.props.region || cdk.Aws.REGION,
       accountId: this.props.accountId,
       query: `${sources} | ${query}`,
     };
 
-    // adding stacked property in case of LINE or STACKEDAREA
+    // Add queryLanguage property if specified
+    if (this.props.queryLanguage) {
+      properties.queryLanguage = this.props.queryLanguage;
+    }
+
+    // Add stacked property in case of LINE or STACKEDAREA
     if (this.props.view === LogQueryVisualizationType.LINE || this.props.view === LogQueryVisualizationType.STACKEDAREA) {
       // assign the right native view value. both types share the same value
       properties.view = 'timeSeries',

packages/@aws-cdk-testing/framework-integ/test/aws-cloudwatch/test/integ.alarm-and-dashboard.js.snapshot/tree.json

@@ -8,6 +8,7 @@ import {
   GraphWidget,
   GraphWidgetView,
   LegendPosition,
+  LogQueryLanguage,
   LogQueryVisualizationType,
   LogQueryWidget,
   Metric,
@@ -319,6 +320,62 @@ describe('Graphs', () => {
     }]);
   });
 
+  test('query result widget - sql', () => {
+    // GIVEN
+    const stack = new Stack();
+    const logGroup = { logGroupName: 'my-log-group' };
+
+    // WHEN
+    const widget = new LogQueryWidget({
+      logGroupNames: [logGroup.logGroupName],
+      view: LogQueryVisualizationType.STACKEDAREA,
+      queryString: "SELECT count(*) as count FROM 'my-log-group'",
+      queryLanguage: LogQueryLanguage.SQL,
+    });
+
+    // THEN
+    expect(stack.resolve(widget.toJson())).toEqual([{
+      type: 'log',
+      width: 6,
+      height: 6,
+      properties: {
+        view: 'timeSeries',
+        stacked: true,
+        region: { Ref: 'AWS::Region' },
+        query: "SOURCE 'my-log-group' | SELECT count(*) as count FROM 'my-log-group'",
+        queryLanguage: 'SQL',
+      },
+    }]);
+  });
+
+  test('query result widget - ppl', () => {
+    // GIVEN
+    const stack = new Stack();
+    const logGroup = { logGroupName: 'my-log-group' };
+
+    // WHEN
+    const widget = new LogQueryWidget({
+      logGroupNames: [logGroup.logGroupName],
+      view: LogQueryVisualizationType.STACKEDAREA,
+      queryString: 'fields `@message`\ | sort - `@timestamp`',
+      queryLanguage: LogQueryLanguage.PPL,
+    });
+
+    // THEN
+    expect(stack.resolve(widget.toJson())).toEqual([{
+      type: 'log',
+      width: 6,
+      height: 6,
+      properties: {
+        view: 'timeSeries',
+        stacked: true,
+        region: { Ref: 'AWS::Region' },
+        query: "SOURCE 'my-log-group' | fields `@message`\ | sort - `@timestamp`",
+        queryLanguage: 'PPL',
+      },
+    }]);
+  });
+
   test('alarm widget', () => {
     // GIVEN
     const stack = new Stack();