Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cloudwatch): Both defaultInterval and start for dashboard cannot be set at once #26971

Merged
merged 4 commits into from
Sep 1, 2023
Merged

docs(cloudwatch): Both defaultInterval and start for dashboard cannot be set at once #26971

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
05d1c52
docs(cloudwatch): add comments that both defaultInterval and start fo…
go-to-k Sep 1, 2023
05571a3
docs: indent
go-to-k Sep 1, 2023
63e280a
Update packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts
kaizencc Sep 1, 2023
d5a97c6
Merge branch 'main' into docs/dashboard-start-default-interval
mergify[bot] Sep 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion packages/aws-cdk-lib/aws-cloudwatch/lib/dashboard.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,11 @@ 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
readonly defaultInterval?: Duration;

/**
* The start of the time range to use for each widget on the dashboard.
Expand All @@ -49,6 +51,8 @@ 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.
*
* 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;
Expand Down