From 05d1c524e356f0e3cbd4799c6f7d233a44301954 Mon Sep 17 00:00:00 2001 From: go-to-k <24818752+go-to-k@users.noreply.github.com> Date: Fri, 1 Sep 2023 20:33:33 +0900 Subject: [PATCH 1/3] docs(cloudwatch): add comments that both defaultInterval and start for dashboard cannot be set at once --- packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts b/packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts index 2cf844c734ca3..fc30ad1900318 100644 --- a/packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts +++ b/packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts @@ -37,6 +37,8 @@ export interface DashboardProps { * Interval duration for metrics. * You can specify defaultInterval with the relative time(eg. cdk.Duration.days(7)). * + * Both properties `defaultInterval` and `start` cannot be set at once. + * * @default When the dashboard loads, the defaultInterval time will be the default time range. */ readonly defaultInterval?: Duration @@ -49,7 +51,9 @@ export interface DashboardProps { * You can also use start along with an end field, to specify an absolute time range. * When specifying an absolute time range, use the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z. * - * @default When the dashboard loads, the start time will be the default time range. + * Both properties `defaultInterval` and `start` cannot be set at once. + * + * @default When the dashboard loads, the start time will be the default time range. */ readonly start?: string; From 05571a3bda6d92db60b2e2c55b518ee6abc2e8e2 Mon Sep 17 00:00:00 2001 From: go-to-k <24818752+go-to-k@users.noreply.github.com> Date: Fri, 1 Sep 2023 20:45:06 +0900 Subject: [PATCH 2/3] docs: indent --- packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts b/packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts index fc30ad1900318..6101a19ecadbd 100644 --- a/packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts +++ b/packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts @@ -53,7 +53,7 @@ export interface DashboardProps { * * Both properties `defaultInterval` and `start` cannot be set at once. * - * @default When the dashboard loads, the start time will be the default time range. + * @default When the dashboard loads, the start time will be the default time range. */ readonly start?: string; From 63e280a1cdded0483959e356bb9f128cbba25aa7 Mon Sep 17 00:00:00 2001 From: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com> Date: Fri, 1 Sep 2023 09:05:47 -0400 Subject: [PATCH 3/3] Update packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts --- packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts b/packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts index 6101a19ecadbd..bf11d4b055d55 100644 --- a/packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts +++ b/packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts @@ -41,7 +41,7 @@ export interface DashboardProps { * * @default When the dashboard loads, the defaultInterval time will be the default time range. */ - readonly defaultInterval?: Duration + readonly defaultInterval?: Duration; /** * The start of the time range to use for each widget on the dashboard.