feat(cloudwatch): validate Dashboards with an end time must also have a start time

[go-to-k]

This PR adds a validation for a start and an end in Dashboard.

It throws an error if you specify an end without a start.

While it is possible to deploy a dashboard with only an end time in CloudFormation, the setting will be ignored and the dashboard displayed with the default time period.

With this validation, we are stopping the faulty deployment early.
API Reference contains the following description and the user will not be aware of this situation.

If you specify a value for end, you must also specify a value for start.

https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html

And each Widget in graph.ts also validates the same case.

https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-cloudwatch/lib/graph.ts#L245-L247

---

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

[lpizzinidev]

Thanks 👍
Just a minor change on the message.

[mrgrain]

@go-to-k Is this failing in CFN if end is provided without start?
Code looks good. Just trying to understand what's going on here.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

[go-to-k]

@mrgrain

Is this failing in CFN if end is provided without start?

No, the deployment succeeds by CFn. Also manual setting without CFn in CloudWatch Dashboard console succeeds.

But that setting is ignored and the dashboard is displayed with the default time period.

I think the deployment should be stopped because the API Reference contains the following description and the user will not be aware of this situation.

If you specify a value for end, you must also specify a value for start.

https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html

And each Widget in graph.ts also validates the same case.

https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-cloudwatch/lib/graph.ts#L245-L247

[mrgrain]

Thank you, save I fully agree. We need to record these explanations on the PR for future reference.

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 0ee4a94
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).