feat(dashboard): add support for dashboard variables (#639)

Fixes #391

Not sure if this change is really needed — I’ve been creating dashboards with variables by just grabbing the underlying dashboards and attaching variables that way. That said, it’s a nice cleanup and does make the code a bit cleaner. Totally fine to close the PR if you don’t think it’s worth it.

---

_By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license_

Author: Laxenade

API.md

@@ -3,6 +3,7 @@ import {
   Dashboard,
   DashboardProps,
   PeriodOverride,
+  IVariable,
 } from "aws-cdk-lib/aws-cloudwatch";
 import { Construct } from "constructs";
 import { BitmapDashboard } from "./BitmapDashboard";
@@ -66,6 +67,12 @@ export interface MonitoringDashboardsProps {
    * @default - DashboardRenderingPreference.INTERACTIVE_ONLY
    */
   readonly renderingPreference?: DashboardRenderingPreference;
+  /**
+   * Dashboard variables to include in the dashboards.
+   *
+   * @default - No variables
+   */
+  readonly variables?: IVariable[];
 }
 
 export enum DefaultDashboards {
@@ -118,6 +125,7 @@ export class DefaultDashboardFactory
         start: detailStart,
         periodOverride:
           props.detailDashboardPeriodOverride ?? PeriodOverride.INHERIT,
+        variables: props.variables,
       });
       this.dashboards[DefaultDashboards.DETAIL] = this.dashboard;
     }
@@ -131,6 +139,7 @@ export class DefaultDashboardFactory
           start: summaryStart,
           periodOverride:
             props.summaryDashboardPeriodOverride ?? PeriodOverride.INHERIT,
+          variables: props.variables,
         },
       );
       this.dashboards[DefaultDashboards.SUMMARY] = this.summaryDashboard;
@@ -145,6 +154,7 @@ export class DefaultDashboardFactory
           start: detailStart,
           periodOverride:
             props.detailDashboardPeriodOverride ?? PeriodOverride.INHERIT,
+          variables: props.variables,
         },
       );
       this.dashboards[DefaultDashboards.ALARMS] = this.alarmDashboard;

lib/dashboard/DefaultDashboardFactory.ts

@@ -3,6 +3,7 @@ import {
   Dashboard,
   DashboardProps,
   PeriodOverride,
+  IVariable,
 } from "aws-cdk-lib/aws-cloudwatch";
 import { Construct } from "constructs";
 
@@ -41,6 +42,13 @@ export interface DynamicDashboardConfiguration {
    * @default - respect individual graphs (PeriodOverride.INHERIT)
    */
   readonly periodOverride?: PeriodOverride;
+
+  /**
+   * Dashboard variables to include in the dashboards.
+   *
+   * @default - No variables
+   */
+  readonly variables?: IVariable[];
 }
 
 export interface MonitoringDynamicDashboardsProps {
@@ -100,6 +108,7 @@ export class DynamicDashboardFactory
           start,
           periodOverride:
             dashboardConfig.periodOverride ?? PeriodOverride.INHERIT,
+          variables: dashboardConfig.variables,
         },
       );
 

lib/dashboard/DynamicDashboardFactory.ts

@@ -1,6 +1,11 @@
 import { Stack } from "aws-cdk-lib";
-import { Template } from "aws-cdk-lib/assertions";
-import { TextWidget } from "aws-cdk-lib/aws-cloudwatch";
+import { Template, Match } from "aws-cdk-lib/assertions";
+import {
+  TextWidget,
+  DashboardVariable,
+  VariableType,
+  VariableInputType,
+} from "aws-cdk-lib/aws-cloudwatch";
 
 import {
   DashboardRenderingPreference,
@@ -69,3 +74,28 @@ test("throws error if an empty dashboardNamePrefix is passed but dashboard are t
     "A non-empty dashboardNamePrefix is required if dashboards are being created",
   );
 });
+
+test("default dashboards include variables", () => {
+  const stack = new Stack();
+
+  const var1 = new DashboardVariable({
+    id: "env",
+    type: VariableType.PROPERTY,
+    inputType: VariableInputType.INPUT,
+    value: "prod",
+  });
+
+  const factory = new DefaultDashboardFactory(stack, "Dashboards", {
+    dashboardNamePrefix: "DummyDashboard",
+    renderingPreference: DashboardRenderingPreference.INTERACTIVE_ONLY,
+    variables: [var1],
+  });
+
+  expect(factory.anyDashboardCreated).toBe(true);
+
+  const template = Template.fromStack(stack);
+
+  template.hasResourceProperties("AWS::CloudWatch::Dashboard", {
+    DashboardBody: Match.stringLikeRegexp('"variables":\\['),
+  });
+});

test/dashboard/DefaultDashboardFactory.test.ts

@@ -1,6 +1,12 @@
 import { Duration, Stack } from "aws-cdk-lib";
-import { Template } from "aws-cdk-lib/assertions";
-import { IWidget, TextWidget } from "aws-cdk-lib/aws-cloudwatch";
+import { Template, Match } from "aws-cdk-lib/assertions";
+import {
+  IWidget,
+  TextWidget,
+  DashboardVariable,
+  VariableType,
+  VariableInputType,
+} from "aws-cdk-lib/aws-cloudwatch";
 import { DynamicDashboardFactory, IDynamicDashboardSegment } from "../../lib";
 
 enum TestDashboards {
@@ -74,3 +80,27 @@ test("does not allow reserved dashboard names", () => {
     });
   }).toThrow("Summary is a reserved name and cannot be used");
 });
+
+test("dynamic dashboards include variables", () => {
+  const stack = new Stack();
+
+  const var1 = new DashboardVariable({
+    id: "env",
+    type: VariableType.PROPERTY,
+    inputType: VariableInputType.INPUT,
+    value: "test",
+  });
+
+  const factory = new DynamicDashboardFactory(stack, "DynamicDashboards", {
+    dashboardNamePrefix: "testPrefix",
+    dashboardConfigs: [{ name: TestDashboards.Dynamic1, variables: [var1] }],
+  });
+
+  factory.addDynamicSegment(new TestSegment());
+
+  const template = Template.fromStack(stack);
+
+  template.hasResourceProperties("AWS::CloudWatch::Dashboard", {
+    DashboardBody: Match.stringLikeRegexp('"variables":\\['),
+  });
+});