feat: deprecate important property in favor of addToSummaryDashboard in CustomMetricGroup (#271)

Resolves #242 

To keep the add to summary naming consistent the new property has been added to CustomMetricGroup.

---

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

Author: Glyphack

API.md

@@ -170,10 +170,16 @@ export interface CustomMetricGroup {
    */
   readonly graphWidgetLegend?: LegendPosition;
   /**
+   * @deprecated use addToSummaryDashboard. addToSummaryDashboard will take precedence over important.
    * Flag indicating, whether this is an important metric group that should be included in the summary as well.
    * @default false
    */
   readonly important?: boolean;
+  /**
+   * Flag indicating this metric group should be included in the summary as well.
+   * @default false
+   */
+  readonly addToSummaryDashboard?: boolean;
   /**
    * list of metrics in the group (can be defined in different ways, see the type documentation)
    */
@@ -304,7 +310,10 @@ export class CustomMonitoring extends Monitoring {
   private getAllWidgets(summary: boolean): IWidget[] {
     const filteredMetricGroups = summary
       ? this.metricGroups.filter(
-          (group) => group.metricGroup.important ?? false
+          (group) =>
+            group.metricGroup.addToSummaryDashboard ??
+            group.metricGroup.important ??
+            false
         )
       : this.metricGroups;
 

lib/monitoring/custom/CustomMonitoring.ts

@@ -37,7 +37,7 @@ test("snapshot test", () => {
     metricGroups: [
       {
         title: "DummyGroup1",
-        important: true,
+        addToSummaryDashboard: true,
         metrics: [
           // regular metric
           new Metric({ metricName: "DummyMetric1", namespace, dimensionsMap }),
@@ -175,6 +175,34 @@ test("snapshot test", () => {
   expect(Template.fromStack(stack)).toMatchSnapshot();
 });
 
+test("addToSummaryDashboard attribute takes precedence over important in metric group", () => {
+  const stack = new Stack();
+  const scope = new TestMonitoringScope(stack, "Scope");
+
+  const monitoring = new CustomMonitoring(scope, {
+    alarmFriendlyName: "DummyAlarmName",
+    humanReadableName: "DummyName",
+    description: "Monitoring widget that shows up in the summary dashboard",
+    descriptionWidgetHeight: 2,
+    height: 100,
+    addToSummaryDashboard: true,
+    metricGroups: [
+      {
+        title: "DummyGroup1",
+        important: false,
+        addToSummaryDashboard: true,
+        metrics: [
+          // regular metric
+          new Metric({ metricName: "DummyMetric1", namespace, dimensionsMap }),
+        ],
+      },
+    ],
+  });
+
+  addMonitoringDashboardsToStack(stack, monitoring);
+  expect(Template.fromStack(stack)).toMatchSnapshot();
+});
+
 test("anomaly detection", () => {
   const stack = new Stack();
   const metricFactory = new MetricFactory({
@@ -403,7 +431,7 @@ test("throws error if attempting to add alarm on a search query", () => {
         metricGroups: [
           {
             title: "DummyGroup1",
-            important: true,
+            addToSummaryDashboard: true,
             metrics: [
               {
                 searchQuery: "DummyMetric4-",
@@ -442,7 +470,7 @@ test("throws error if attempting to add both a regular alarm and an anomoly dete
         metricGroups: [
           {
             title: "DummyGroup1",
-            important: true,
+            addToSummaryDashboard: true,
             metrics: [
               {
                 metric: new Metric({