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.

The auto-deletion for objects within S3 buckets is handled by a custom resource. Enabling this feature by setting it to true would additionally include the imposition of the `s3:PutBucketPolicy` to restrict external write access during cleanup, thus mitigating potential race conditions.
SankyRed marked this conversation as resolved.
Show resolved Hide resolved

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