docs(s3): add example to s3 bucket documentation#21110
docs(s3): add example to s3 bucket documentation#21110mergify[bot] merged 4 commits intoaws:mainfrom
Conversation
|
|
|
@peterwoodworth I have now added a pull request with an example, but as we discussed, I don't know how it renders it 😅 It would be nice to get some feedback from you how it looks like. Thanks in advance! ❤️ |
peterwoodworth
left a comment
There was a problem hiding this comment.
This is how it's supposed to be formatted! good job 🙂
It appears that there's extra spaces / indentation, could you make sure that the start of the example new s3.Bucket... is the same indentation as the @ example line?
As for props - I'd request that we do not specify the bucketName. We actually recommend against this as best practice, see here
I honestly wouldn't mind if we don't have props, but take a look through the overview page. Anything related to encryption, blocking public access, bucket deletion, etc would be great to have here.
Also be sure to put a semicolon at the end of the bucket declaration!
Pull request has been modified.
|
@peterwoodworth Thank you for your detailed answers! I have added the requested changes. I hope it's ok like that, otherwise I would appreciate your feedback :) |
|
Oops. Looks like the spacing with the imports got a bit messed up with this revision. |
|
@TheRealAmazonKendra 🤦🏼 I don't know how this happened. I fixed it with |
TheRealAmazonKendra
left a comment
There was a problem hiding this comment.
Looks good! Thanks for the change!
|
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). |
Fixes #20374
Adds an example to the S3
Bucketdocstring.All Submissions:
Adding new Unconventional Dependencies:
New Features
yarn integto deploy the infrastructure and generate the snapshot (i.e.yarn integwithout--dry-run)?By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license