feat(cloudwatch): dashboardName validation

aws · eladb · Jul 23, 2019 · Jul 22, 2019 · Jul 22, 2019 · Jul 22, 2019
commit 2bbdc9b106a91fc9037d786d0a3b397369722fed
diff --git a/packages/@aws-cdk/aws-cloudwatch/lib/dashboard.ts b/packages/@aws-cdk/aws-cloudwatch/lib/dashboard.ts
@@ -10,7 +10,8 @@ export enum PeriodOverride {
 
 export interface DashboardProps {
   /**
-   * Name of the dashboard
+   * Name of the dashboard.
+   * If set, must only contain alphanumerics, dash (-) and underscore (_)
    *
    * @default Automatically generated name
    */
@@ -67,6 +68,10 @@ export class Dashboard extends Resource {
       physicalName: props.dashboardName,
     });
 
+    if (props.dashboardName && !props.dashboardName.match(/^[\w-]+$/)) {
+      throw new Error(`The value ${props.dashboardName} for field dashboardName contains invalid characters. It can only contain alphanumerics, dash (-) and underscore (_).`);
+    }
+
     new CfnDashboard(this, 'Resource', {
       dashboardName: this.physicalName,
       dashboardBody: Lazy.stringValue({ produce: () => {

diff --git a/packages/@aws-cdk/aws-cloudwatch/test/test.dashboard.ts b/packages/@aws-cdk/aws-cloudwatch/test/test.dashboard.ts
@@ -149,6 +149,24 @@ export = {
     // THEN
     expect(stack).to(haveResource('AWS::CloudWatch::Dashboard', {}));
 
+    test.done();
+  },
+
+  'throws if DashboardName is not valid'(test: Test) {
+    // GIVEN
+    const app = new App();
+    const stack = new Stack(app, 'MyStack');
+
+    // WHEN
+    const toThrow = () => {
+      new Dashboard(stack, 'MyDashboard', {
+        dashboardName: 'My Invalid Dashboard Name',
+      });
+    };
+
+    // THEN
+    test.throws(() => toThrow());
+
     test.done();
   }
 };