-
Notifications
You must be signed in to change notification settings - Fork 4k
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.
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(s3): updated docstring for BucketPolicy() #31395
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request
. Additionally, if clarification is needed add Clarification Request
to a comment.
Exemption Request |
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
Pull request has been modified.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you keep missing linter errors on this doc change :). you can run cdk lint --fix
on your local setup to make sure that it passes the linter before the PR stage.
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 CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
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). |
Comments on closed issues and PRs are hard for our team to see. |
sounds good. will keep in mind for the next time. :) Thanks. |
Issue #31358
Closes #31358 .
Reason for this change
Exsiting CDK Doc on BucketPolicy mentions as
Prefer to use
which is misleading as it does not clearly states the reprecussions.Description of changes
I have added a sample of what would happen if this is used along with other Bucket properties.
Description of how you validated changes
This is a minor documentation change
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license