Skip to content

Commit

Permalink
docs(aws-s3 README): Clarify autoDeleteObjects warning to include "…
Browse files Browse the repository at this point in the history
…deploy" step. (#16857)

## Summary

This PR is a continuation of #16828 (review)

We want to make sure users know to deploy with the latest CDK version before toggling the `autoDeleteObjects` prop to `false`.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
ryparker authored Oct 7, 2021
1 parent 27cc821 commit 969673c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions packages/@aws-cdk/aws-s3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,6 @@ const bucket = new Bucket(this, 'MyTempFileBucket', {
```

**Warning** if you have deployed a bucket with `autoDeleteObjects: true`,
switching this to `false` in a CDK version *before* `1.126.0` will lead to all
objects in the bucket being deleted. Be sure to update to version `1.126.0` or
later before switching this value to `false`.
switching this to `false` in a CDK version *before* `1.126.0` will lead to
all objects in the bucket being deleted. Be sure to update your bucket resources
by deploying with CDK version `1.126.0` or later **before** switching this value to `false`.

0 comments on commit 969673c

Please sign in to comment.