aws / aws-cdk

The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code
https://aws.amazon.com/cdk
Apache License 2.0
11.68k stars 3.93k forks source link

docs(s3): updated docstring for BucketPolicy() #31395

Closed khushail closed 2 months ago

khushail commented 2 months ago

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

khushail commented 2 months ago

Exemption Request

mergify[bot] commented 2 months ago

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 commented 2 months ago

AWS CodeBuild CI Report

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

mergify[bot] commented 2 months ago

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).

github-actions[bot] commented 2 months ago

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.

khushail commented 2 months ago

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.

sounds good. will keep in mind for the next time. :) Thanks.