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): update documentation for more context around autoDeleteObjects #30096

Merged
merged 10 commits into from
May 10, 2024
2 changes: 2 additions & 0 deletions packages/aws-cdk-lib/aws-s3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -622,6 +622,8 @@ as it does not contain any objects.
To override this and force all objects to get deleted during bucket deletion,
enable the`autoDeleteObjects` option.

In order to facilitate bucket deletion, we add the `s3:PutBucketPolicy` action from AWS Identity and Access Management (IAM) policies. This action authorizes users to manage bucket policies for Amazon S3 buckets, enabling them to adjust access control settings by either establishing new policies or modifying existing ones. As part of this we update the policy to **Deny** `s3:PutObject` action within the specified bucket preventing new objects from being created in the bucket. Consequently, this measure ensures that during the bucket emptying phase, the onset of potential race conditions is mitigated, as no new objects can be generated within the bucket.
SankyRed marked this conversation as resolved.
Show resolved Hide resolved

```ts
const bucket = new s3.Bucket(this, 'MyTempFileBucket', {
removalPolicy: cdk.RemovalPolicy.DESTROY,
Expand Down