feat(custom): add graphWidgetSetPeriodToTimeRange (#482)

Corresponds with `setPeriodToTimeRange` from [GraphWidgetProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.GraphWidgetProps.html): > Whether to show the value from the entire time range. Only applicable for Bar and Pie charts. Closes #449 --- _By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license_
cdklabs · Jan 16, 2024 · 1346726 · 1346726
1 parent 4beb259
commit 1346726
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 1 deletion.
diff --git a/API.md b/API.md
diff --git a/lib/monitoring/custom/CustomMonitoring.ts b/lib/monitoring/custom/CustomMonitoring.ts
@@ -169,6 +169,10 @@ export interface CustomMetricGroup {
    * @default BOTTOM
    */
   readonly graphWidgetLegend?: LegendPosition;
+  /**
+   * @see {GraphWidgetProps.setPeriodToTimeRange}
+   */
+  readonly graphWidgetSetPeriodToTimeRange?: boolean;
   /**
    * @deprecated use addToSummaryDashboard. addToSummaryDashboard will take precedence over important.
    * @see addToSummaryDashboard
@@ -409,6 +413,8 @@ export class CustomMonitoring extends Monitoring {
         leftYAxis: annotatedGroup.metricGroup.graphWidgetAxis,
         rightYAxis: annotatedGroup.metricGroup.graphWidgetRightAxis,
         legendPosition: annotatedGroup.metricGroup.graphWidgetLegend,
+        setPeriodToTimeRange:
+          annotatedGroup.metricGroup.graphWidgetSetPeriodToTimeRange,
       };
 
       const widget = useAnomalyDetectionWidget

diff --git a/test/monitoring/custom/CustomMonitoring.test.ts b/test/monitoring/custom/CustomMonitoring.test.ts
@@ -107,6 +107,7 @@ test("snapshot test", () => {
       {
         title: "DummyGroup3",
         graphWidgetType: GraphWidgetType.PIE,
+        graphWidgetSetPeriodToTimeRange: true,
         metrics: [
           // regular metric
           new Metric({ metricName: "DummyMetric20", namespace, dimensionsMap }),

diff --git a/test/monitoring/custom/__snapshots__/CustomMonitoring.test.ts.snap b/test/monitoring/custom/__snapshots__/CustomMonitoring.test.ts.snap