feat(facade): add defaults to make facade creation easier (#145)

Making the creation of monitoring facade easier (require less props) by introducing defaults.

---

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

Author: voho

API.md

@@ -691,7 +691,7 @@ Main entry point to create your monitoring.
 ```typescript
 import { MonitoringFacade } from 'cdk-monitoring-constructs'
 
-new MonitoringFacade(scope: Construct, id: string, props: MonitoringFacadeProps)
+new MonitoringFacade(scope: Construct, id: string, props?: MonitoringFacadeProps)
 ```
 
 | **Name** | **Type** | **Description** |
@@ -714,7 +714,7 @@ new MonitoringFacade(scope: Construct, id: string, props: MonitoringFacadeProps)
 
 ---
 
-##### `props`<sup>Required</sup> <a name="props" id="cdk-monitoring-constructs.MonitoringFacade.Initializer.parameter.props"></a>
+##### `props`<sup>Optional</sup> <a name="props" id="cdk-monitoring-constructs.MonitoringFacade.Initializer.parameter.props"></a>
 
 - *Type:* <a href="#cdk-monitoring-constructs.MonitoringFacadeProps">MonitoringFacadeProps</a>
 
@@ -24223,83 +24223,74 @@ const monitoringDashboardsProps: MonitoringDashboardsProps = { ... }
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
+| <code><a href="#cdk-monitoring-constructs.MonitoringDashboardsProps.property.dashboardNamePrefix">dashboardNamePrefix</a></code> | <code>string</code> | Prefix added to each dashboard name. |
 | <code><a href="#cdk-monitoring-constructs.MonitoringDashboardsProps.property.createAlarmDashboard">createAlarmDashboard</a></code> | <code>boolean</code> | Flag indicating whether the alarm dashboard should be created. |
 | <code><a href="#cdk-monitoring-constructs.MonitoringDashboardsProps.property.createDashboard">createDashboard</a></code> | <code>boolean</code> | Flag indicating whether the default dashboard should be created. |
 | <code><a href="#cdk-monitoring-constructs.MonitoringDashboardsProps.property.createSummaryDashboard">createSummaryDashboard</a></code> | <code>boolean</code> | Flag indicating whether the summary dashboard should be created. |
-| <code><a href="#cdk-monitoring-constructs.MonitoringDashboardsProps.property.dashboardNamePrefix">dashboardNamePrefix</a></code> | <code>string</code> | Prefix added to each dashboard name. |
-| <code><a href="#cdk-monitoring-constructs.MonitoringDashboardsProps.property.renderingPreference">renderingPreference</a></code> | <code><a href="#cdk-monitoring-constructs.DashboardRenderingPreference">DashboardRenderingPreference</a></code> | Dashboard rendering preference. |
 | <code><a href="#cdk-monitoring-constructs.MonitoringDashboardsProps.property.detailDashboardPeriodOverride">detailDashboardPeriodOverride</a></code> | <code>aws-cdk-lib.aws_cloudwatch.PeriodOverride</code> | Period override for the detail dashboard (and other auxiliary dashboards). |
 | <code><a href="#cdk-monitoring-constructs.MonitoringDashboardsProps.property.detailDashboardRange">detailDashboardRange</a></code> | <code>aws-cdk-lib.Duration</code> | Range of the detail dashboard (and other auxiliary dashboards). |
+| <code><a href="#cdk-monitoring-constructs.MonitoringDashboardsProps.property.renderingPreference">renderingPreference</a></code> | <code><a href="#cdk-monitoring-constructs.DashboardRenderingPreference">DashboardRenderingPreference</a></code> | Dashboard rendering preference. |
 | <code><a href="#cdk-monitoring-constructs.MonitoringDashboardsProps.property.summaryDashboardPeriodOverride">summaryDashboardPeriodOverride</a></code> | <code>aws-cdk-lib.aws_cloudwatch.PeriodOverride</code> | Period override for the summary dashboard. |
 | <code><a href="#cdk-monitoring-constructs.MonitoringDashboardsProps.property.summaryDashboardRange">summaryDashboardRange</a></code> | <code>aws-cdk-lib.Duration</code> | Range of the summary dashboard. |
 
 ---
 
-##### `createAlarmDashboard`<sup>Required</sup> <a name="createAlarmDashboard" id="cdk-monitoring-constructs.MonitoringDashboardsProps.property.createAlarmDashboard"></a>
+##### `dashboardNamePrefix`<sup>Required</sup> <a name="dashboardNamePrefix" id="cdk-monitoring-constructs.MonitoringDashboardsProps.property.dashboardNamePrefix"></a>
 
 ```typescript
-public readonly createAlarmDashboard: boolean;
+public readonly dashboardNamePrefix: string;
 ```
 
-- *Type:* boolean
+- *Type:* string
 
-Flag indicating whether the alarm dashboard should be created.
+Prefix added to each dashboard name.
 
-This is independent on other create dashboard flags.
+This allows to have all dashboards sorted close to each other and also separate multiple monitoring facades.
 
 ---
 
-##### `createDashboard`<sup>Required</sup> <a name="createDashboard" id="cdk-monitoring-constructs.MonitoringDashboardsProps.property.createDashboard"></a>
+##### `createAlarmDashboard`<sup>Optional</sup> <a name="createAlarmDashboard" id="cdk-monitoring-constructs.MonitoringDashboardsProps.property.createAlarmDashboard"></a>
 
 ```typescript
-public readonly createDashboard: boolean;
+public readonly createAlarmDashboard: boolean;
 ```
 
 - *Type:* boolean
+- *Default:* false
 
-Flag indicating whether the default dashboard should be created.
+Flag indicating whether the alarm dashboard should be created.
 
 This is independent on other create dashboard flags.
 
 ---
 
-##### `createSummaryDashboard`<sup>Required</sup> <a name="createSummaryDashboard" id="cdk-monitoring-constructs.MonitoringDashboardsProps.property.createSummaryDashboard"></a>
+##### `createDashboard`<sup>Optional</sup> <a name="createDashboard" id="cdk-monitoring-constructs.MonitoringDashboardsProps.property.createDashboard"></a>
 
 ```typescript
-public readonly createSummaryDashboard: boolean;
+public readonly createDashboard: boolean;
 ```
 
 - *Type:* boolean
+- *Default:* true
 
-Flag indicating whether the summary dashboard should be created.
+Flag indicating whether the default dashboard should be created.
 
 This is independent on other create dashboard flags.
 
 ---
 
-##### `dashboardNamePrefix`<sup>Required</sup> <a name="dashboardNamePrefix" id="cdk-monitoring-constructs.MonitoringDashboardsProps.property.dashboardNamePrefix"></a>
+##### `createSummaryDashboard`<sup>Optional</sup> <a name="createSummaryDashboard" id="cdk-monitoring-constructs.MonitoringDashboardsProps.property.createSummaryDashboard"></a>
 
 ```typescript
-public readonly dashboardNamePrefix: string;
+public readonly createSummaryDashboard: boolean;
 ```
 
-- *Type:* string
-
-Prefix added to each dashboard name.
-
-This allows to have all dashboards sorted close to each other and also separate multiple monitoring facades.
-
----
-
-##### `renderingPreference`<sup>Required</sup> <a name="renderingPreference" id="cdk-monitoring-constructs.MonitoringDashboardsProps.property.renderingPreference"></a>
-
-```typescript
-public readonly renderingPreference: DashboardRenderingPreference;
-```
+- *Type:* boolean
+- *Default:* false
 
-- *Type:* <a href="#cdk-monitoring-constructs.DashboardRenderingPreference">DashboardRenderingPreference</a>
+Flag indicating whether the summary dashboard should be created.
 
-Dashboard rendering preference.
+This is independent on other create dashboard flags.
 
 ---
 
@@ -24331,6 +24322,19 @@ Range of the detail dashboard (and other auxiliary dashboards).
 
 ---
 
+##### `renderingPreference`<sup>Optional</sup> <a name="renderingPreference" id="cdk-monitoring-constructs.MonitoringDashboardsProps.property.renderingPreference"></a>
+
+```typescript
+public readonly renderingPreference: DashboardRenderingPreference;
+```
+
+- *Type:* <a href="#cdk-monitoring-constructs.DashboardRenderingPreference">DashboardRenderingPreference</a>
+- *Default:* DashboardRenderingPreference.INTERACTIVE_ONLY
+
+Dashboard rendering preference.
+
+---
+
 ##### `summaryDashboardPeriodOverride`<sup>Optional</sup> <a name="summaryDashboardPeriodOverride" id="cdk-monitoring-constructs.MonitoringDashboardsProps.property.summaryDashboardPeriodOverride"></a>
 
 ```typescript
@@ -24371,39 +24375,48 @@ const monitoringFacadeProps: MonitoringFacadeProps = { ... }
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#cdk-monitoring-constructs.MonitoringFacadeProps.property.alarmFactoryDefaults">alarmFactoryDefaults</a></code> | <code><a href="#cdk-monitoring-constructs.AlarmFactoryDefaults">AlarmFactoryDefaults</a></code> | *No description.* |
-| <code><a href="#cdk-monitoring-constructs.MonitoringFacadeProps.property.metricFactoryDefaults">metricFactoryDefaults</a></code> | <code><a href="#cdk-monitoring-constructs.MetricFactoryDefaults">MetricFactoryDefaults</a></code> | *No description.* |
-| <code><a href="#cdk-monitoring-constructs.MonitoringFacadeProps.property.dashboardFactory">dashboardFactory</a></code> | <code><a href="#cdk-monitoring-constructs.IDashboardFactory">IDashboardFactory</a></code> | *No description.* |
+| <code><a href="#cdk-monitoring-constructs.MonitoringFacadeProps.property.alarmFactoryDefaults">alarmFactoryDefaults</a></code> | <code><a href="#cdk-monitoring-constructs.AlarmFactoryDefaults">AlarmFactoryDefaults</a></code> | Defaults for alarm factory. |
+| <code><a href="#cdk-monitoring-constructs.MonitoringFacadeProps.property.dashboardFactory">dashboardFactory</a></code> | <code><a href="#cdk-monitoring-constructs.IDashboardFactory">IDashboardFactory</a></code> | Defaults for dashboard factory. |
+| <code><a href="#cdk-monitoring-constructs.MonitoringFacadeProps.property.metricFactoryDefaults">metricFactoryDefaults</a></code> | <code><a href="#cdk-monitoring-constructs.MetricFactoryDefaults">MetricFactoryDefaults</a></code> | Defaults for metric factory. |
 
 ---
 
-##### `alarmFactoryDefaults`<sup>Required</sup> <a name="alarmFactoryDefaults" id="cdk-monitoring-constructs.MonitoringFacadeProps.property.alarmFactoryDefaults"></a>
+##### `alarmFactoryDefaults`<sup>Optional</sup> <a name="alarmFactoryDefaults" id="cdk-monitoring-constructs.MonitoringFacadeProps.property.alarmFactoryDefaults"></a>
 
 ```typescript
 public readonly alarmFactoryDefaults: AlarmFactoryDefaults;
 ```
 
 - *Type:* <a href="#cdk-monitoring-constructs.AlarmFactoryDefaults">AlarmFactoryDefaults</a>
+- *Default:* actions enabled, facade logical ID used as default alarm name prefix
+
+Defaults for alarm factory.
 
 ---
 
-##### `metricFactoryDefaults`<sup>Required</sup> <a name="metricFactoryDefaults" id="cdk-monitoring-constructs.MonitoringFacadeProps.property.metricFactoryDefaults"></a>
+##### `dashboardFactory`<sup>Optional</sup> <a name="dashboardFactory" id="cdk-monitoring-constructs.MonitoringFacadeProps.property.dashboardFactory"></a>
 
 ```typescript
-public readonly metricFactoryDefaults: MetricFactoryDefaults;
+public readonly dashboardFactory: IDashboardFactory;
 ```
 
-- *Type:* <a href="#cdk-monitoring-constructs.MetricFactoryDefaults">MetricFactoryDefaults</a>
+- *Type:* <a href="#cdk-monitoring-constructs.IDashboardFactory">IDashboardFactory</a>
+- *Default:* `DefaultDashboardFactory`; facade logical ID used as default name
+
+Defaults for dashboard factory.
 
 ---
 
-##### `dashboardFactory`<sup>Optional</sup> <a name="dashboardFactory" id="cdk-monitoring-constructs.MonitoringFacadeProps.property.dashboardFactory"></a>
+##### `metricFactoryDefaults`<sup>Optional</sup> <a name="metricFactoryDefaults" id="cdk-monitoring-constructs.MonitoringFacadeProps.property.metricFactoryDefaults"></a>
 
 ```typescript
-public readonly dashboardFactory: IDashboardFactory;
+public readonly metricFactoryDefaults: MetricFactoryDefaults;
 ```
 
-- *Type:* <a href="#cdk-monitoring-constructs.IDashboardFactory">IDashboardFactory</a>
+- *Type:* <a href="#cdk-monitoring-constructs.MetricFactoryDefaults">MetricFactoryDefaults</a>
+- *Default:* empty (no preferences)
+
+Defaults for metric factory.
 
 ---
 

lib/dashboard/DefaultDashboardFactory.d.ts.map

@@ -58,22 +58,30 @@ export interface MonitoringDashboardsProps {
   /**
    * Flag indicating whether the default dashboard should be created.
    * This is independent on other create dashboard flags.
+   *
+   * @default true
    */
-  readonly createDashboard: boolean;
+  readonly createDashboard?: boolean;
   /**
    * Flag indicating whether the summary dashboard should be created.
    * This is independent on other create dashboard flags.
+   *
+   * @default false
    */
-  readonly createSummaryDashboard: boolean;
+  readonly createSummaryDashboard?: boolean;
   /**
    * Flag indicating whether the alarm dashboard should be created.
    * This is independent on other create dashboard flags.
+   *
+   * @default false
    */
-  readonly createAlarmDashboard: boolean;
+  readonly createAlarmDashboard?: boolean;
   /**
    * Dashboard rendering preference.
+   *
+   * @default DashboardRenderingPreference.INTERACTIVE_ONLY
    */
-  readonly renderingPreference: DashboardRenderingPreference;
+  readonly renderingPreference?: DashboardRenderingPreference;
 }
 
 export class DefaultDashboardFactory
@@ -88,29 +96,28 @@ export class DefaultDashboardFactory
   constructor(scope: Construct, id: string, props: MonitoringDashboardsProps) {
     super(scope, id);
 
+    const renderingPreference =
+      props.renderingPreference ??
+      DashboardRenderingPreference.INTERACTIVE_ONLY;
     const detailStart: string =
       "-" + (props.detailDashboardRange ?? Duration.hours(8)).toIsoString();
     const summaryStart: string =
       "-" + (props.summaryDashboardRange ?? Duration.days(14)).toIsoString();
     let anyDashboardCreated = false;
 
-    if (props.createDashboard) {
+    if (props.createDashboard ?? true) {
       anyDashboardCreated = true;
-      this.dashboard = this.createDashboard(
-        props.renderingPreference,
-        "Dashboard",
-        {
-          dashboardName: props.dashboardNamePrefix,
-          start: detailStart,
-          periodOverride:
-            props.detailDashboardPeriodOverride ?? PeriodOverride.INHERIT,
-        }
-      );
+      this.dashboard = this.createDashboard(renderingPreference, "Dashboard", {
+        dashboardName: props.dashboardNamePrefix,
+        start: detailStart,
+        periodOverride:
+          props.detailDashboardPeriodOverride ?? PeriodOverride.INHERIT,
+      });
     }
-    if (props.createSummaryDashboard) {
+    if (props.createSummaryDashboard ?? false) {
       anyDashboardCreated = true;
       this.summaryDashboard = this.createDashboard(
-        props.renderingPreference,
+        renderingPreference,
         "SummaryDashboard",
         {
           dashboardName: `${props.dashboardNamePrefix}-Summary`,
@@ -120,10 +127,10 @@ export class DefaultDashboardFactory
         }
       );
     }
-    if (props.createAlarmDashboard) {
+    if (props.createAlarmDashboard ?? false) {
       anyDashboardCreated = true;
       this.alarmDashboard = this.createDashboard(
-        props.renderingPreference,
+        renderingPreference,
         "AlarmDashboard",
         {
           dashboardName: `${props.dashboardNamePrefix}-Alarms`,