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

Jump to bottom

(BackupPlanRule): the completion_window default value does not match the documentation #27050

Closed
dilpreetSingh12 opened this issue Sep 7, 2023 · 4 comments · Fixed by #27061
Closed

(BackupPlanRule): the completion_window default value does not match the documentation #27050

dilpreetSingh12 opened this issue Sep 7, 2023 · 4 comments · Fixed by #27061
Labels
bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort good first issue Related to contributions. See CONTRIBUTING.md p2 package/tools Related to AWS CDK Tools or CLI

Comments

@dilpreetSingh12
Copy link

Describe the bug

https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_backup/BackupPlanRule.html states that completion_window default value is 8 hours but it is set to 7 days.

Expected Behavior

completion_window default value shall be set to 8 hours

Current Behavior

completion_window default value is set to 7 days.

Reproduction Steps

Create a backplan rule via aws cdk python.

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.85.0

Framework Version

No response

Node.js Version

v18.13.0

OS

mac

Language

Python

Language Version

No response

Other information

No response
@dilpreetSingh12 dilpreetSingh12 added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Sep 7, 2023
@github-actions github-actions bot added the package/tools Related to AWS CDK Tools or CLI label Sep 7, 2023
@peterwoodworth peterwoodworth added good first issue Related to contributions. See CONTRIBUTING.md p2 effort/small Small work item – less than a day of effort and removed needs-triage This issue or PR still needs to be triaged. labels Sep 7, 2023
@peterwoodworth
Copy link
Contributor

peterwoodworth commented Sep 7, 2023 •
edited
Loading

Yep, can confirm this. Thanks for reporting, it's likely that this got mixed up with the default for startWindow. Would need to change the docstring here to 7 days
Screenshot 2023-09-07 at 11 38 28 AM

aws-cdk/packages/aws-cdk-lib/aws-backup/lib/rule.ts

Line 13 in 987c329

* @default - 8 hours

@peterwoodworth peterwoodworth added the documentation This is a problem with documentation. label Sep 7, 2023
@tam0ri tam0ri mentioned this issue Sep 8, 2023
Merged
@lpizzinidev
Copy link
Contributor

@peterwoodworth
I don't see the default values for completionWindow and startWindow being set when a new rule is added to the backup plan.
Shouldn't we fall back to the declared defaults if the two attributes are not defined?

@kaizencc
Copy link
Contributor

kaizencc commented Sep 8, 2023

@lpizzinidev sometimes we default to the cloudformation defaults but declare those in documentation for cdk. That looks like what is happening here.

@mergify mergify bot closed this as completed in #27061 Sep 8, 2023
mergify bot pushed a commit that referenced this issue Sep 8, 2023
@tam0ri
docs(backup): default value for completionWindow is incorrect (#27061)
0ebad42 
Currently, the description regarding default value for `completionWindow` is incorrect.
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_backup.BackupPlanRuleProps.html#completionwindow
> Type: Duration (optional, default: 8 hours)

Correct value is 7 days (10080 minutes).

Closes #27050

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

github-actions bot commented Sep 8, 2023

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

mikewrighton pushed a commit that referenced this issue Sep 14, 2023
@tam0ri
docs(backup): default value for completionWindow is incorrect (#27061)
3968e39 
Currently, the description regarding default value for `completionWindow` is incorrect.
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_backup.BackupPlanRuleProps.html#completionwindow
> Type: Duration (optional, default: 8 hours)

Correct value is 7 days (10080 minutes).

Closes #27050

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions github-actions bot mentioned this issue Oct 1, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort good first issue Related to contributions. See CONTRIBUTING.md p2 package/tools Related to AWS CDK Tools or CLI
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(backup): default value for completionWindow is incorrect tam0ri/aws-cdk
4 participants
@lpizzinidev @kaizencc @peterwoodworth @dilpreetSingh12