Skip to content

Commit

Permalink
chore(s3): update default object ownership docstring (#31152)
Browse files Browse the repository at this point in the history
### Issue # (if applicable)

n/a

### Reason for this change

In April 2023, S3 changed the defaults for S3 buckets so Object Ownership is set to the Bucket owner enforced setting and all ACLs are disabled (see [blog](https://aws.amazon.com/about-aws/whats-new/2022/12/amazon-s3-automatically-enable-block-public-access-disable-access-control-lists-buckets-april-2023/)). 
See current docs as well: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html 

### Description of changes

Update `objectOwnership` docstring to reflect the updated default setting. No change in CDK behaviour.

### Description of how you validated changes

n/a

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
gracelu0 authored Aug 19, 2024
1 parent 1eb1ea6 commit 4e7d480
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion packages/aws-cdk-lib/aws-s3/lib/bucket.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1636,7 +1636,8 @@ export interface BucketProps {
*
* @see https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html
*
* @default - No ObjectOwnership configuration, uploading account will own the object.
* @default - No ObjectOwnership configuration. By default, Amazon S3 sets Object Ownership to `Bucket owner enforced`.
* This means ACLs are disabled and the bucket owner will own every object.
*
*/
readonly objectOwnership?: ObjectOwnership;
Expand Down

0 comments on commit 4e7d480

Please sign in to comment.