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

(ObjectOwnership): (Update documentation to be more explicit to match S3 documentation) #28866

Closed
jramacha opened this issue Jan 25, 2024 · 1 comment · Fixed by #28867
Closed
Labels
@aws-cdk/aws-s3 Related to Amazon S3 documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged.

Comments

@jramacha
Copy link
Contributor

Describe the issue

When we created a S3 bucket via Bucket construct we used the BUCKET_OWNER_PREFERRED setting for objectOwnership but we found Objects uploaded to the bucket DIDN’T change ownership to the bucket owner and we had problems downloading the objects.

Then we found out if the objects are being uploaded to the bucket without bucket-owner-full-control canned ACL, the bucket owner won’t have permissions see S3 documentation but the CDK documentation doesn’t mention it explicitly, It currently has

BUCKET_OWNER_PREFERRED

Objects uploaded to the bucket change ownership to the bucket owner .

We had to explicitly change the enum to BUCKET_OWNER_ENFORCED or upload the objects with the canned acl see support article

So we propose the documentation be updated to be more explicit similar to S3 documentation.

The bucket owner owns and has full control over new objects that other accounts write to the bucket with the bucket-owner-full-control canned ACL. 

We used CDK(Typescript) but other languages could be updated as well.

Discussed with Kaizen before entering this PR.

Thank you

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.ObjectOwnership.html#bucket_owner_preferred

https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_s3/ObjectOwnership.html

https://docs.aws.amazon.com/cdk/api/v2/java/software/amazon/awscdk/services/s3/ObjectOwnership.html

https://pkg.go.dev/github.com/aws/aws-cdk-go/awscdk/v2/awss3#ObjectOwnership

https://pkg.go.dev/github.com/aws/aws-cdk-go/awscdk/v2/awss3#ObjectOwnership

https://docs.aws.amazon.com/cdk/api/v2/dotnet/api/Amazon.CDK.AWS.S3.ObjectOwnership.html

@jramacha jramacha added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Jan 25, 2024
@github-actions github-actions bot added the @aws-cdk/aws-s3 Related to Amazon S3 label Jan 25, 2024
@mergify mergify bot closed this as completed in #28867 Jan 25, 2024
mergify bot pushed a commit that referenced this issue Jan 25, 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*
Copy link

⚠️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.

Vandita2020 pushed a commit to Vandita2020/aws-cdk that referenced this issue 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 issue 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
@aws-cdk/aws-s3 Related to Amazon S3 documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant