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.

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): better explain behavior of BUCKET_OWNER_PREFERRED #28867

Merged
merged 4 commits into from
Jan 25, 2024

Conversation

jramacha
Copy link
Contributor

Update the enum ObjectOwnership docs to be more explicit. As mentioned here the documentation is not explicit but in S3 documentation its explicit. We had discussed with Kaizen in issue before entering this PR/Issue.

Closes #28866 .


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

Update the enum ObjectOwnership to be more explicit.
@github-actions github-actions bot added p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Jan 25, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team January 25, 2024 20:23
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a 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.

@jramacha jramacha changed the title Minor update to bucket.ts docs(s3): Minor update to bucket.ts comment to be more explicit Jan 25, 2024
@@ -1291,7 +1291,7 @@ export enum ObjectOwnership {
*/
BUCKET_OWNER_PREFERRED = 'BucketOwnerPreferred',
/**
* The uploading account will own the object.
* The bucket owner will own the object if the object is uploaded with the bucket-owner-full-control canned ACL. Without this setting and canned ACL, the object is uploaded and remains owned by the uploading account.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue mentions BUCKET_OWNER_PREFERRED, but we are updating OBJECT_WRITER's docstring here. Did you mean to update BUCKET_OWNER_PREFERRED instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops.. Thanks for catching it ,I'll update it.

@kaizencc kaizencc changed the title docs(s3): Minor update to bucket.ts comment to be more explicit docs(s3): better explain behavior of BUCKET_OWNER_PREFERRED Jan 25, 2024
Update the comment based on the feedback.
@kaizencc kaizencc changed the title docs(s3): better explain behavior of BUCKET_OWNER_PREFERRED docs(s3): better explain behavior of BUCKET_OWNER_PREFERRED Jan 25, 2024
Copy link
Contributor

@kaizencc kaizencc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@aws-cdk-automation aws-cdk-automation dismissed their stale review January 25, 2024 21:06

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

Copy link
Contributor

mergify bot commented Jan 25, 2024

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
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mergify mergify bot merged commit efccfcb into aws:main Jan 25, 2024
9 checks passed
Copy link
Contributor

mergify bot commented Jan 25, 2024

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

Vandita2020 pushed a commit to Vandita2020/aws-cdk that referenced this pull request Jan 30, 2024
Update the enum ObjectOwnership docs to be more explicit. As mentioned [here](aws#28866) the documentation is not explicit but in S3 [documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) its explicit. We had discussed with Kaizen in [issue](aws#28866) before entering this PR/Issue.



Closes aws#28866 .


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
SankyRed pushed a commit that referenced this pull request Feb 8, 2024
Update the enum ObjectOwnership docs to be more explicit. As mentioned [here](#28866) the documentation is not explicit but in S3 [documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) its explicit. We had discussed with Kaizen in [issue](#28866) before entering this PR/Issue.



Closes #28866 .


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(ObjectOwnership): (Update documentation to be more explicit to match S3 documentation)
3 participants