Skip to content

Commit ce54461

Browse files
authored
chore(dynamodb): update waitForReplicationToFinish flag summary doc to highlight that it may cause deletion for existing replicas. (#31432)
### Description of changes Add a warning message to the summary doc of the flag `waitForReplicationToFinish` to highlight that misusing this flag may cause deletion for existing replicas. This change is required to resolve some internal feedback as some people may miss reading the detail documentation of that flag, and so they will may misuse it and then have some serious issues. ### Description of how you validated changes see the below image for the updated doc: <img width="728" alt="Screenshot 2024-09-12 at 3 42 22 PM" src="https://github.com/user-attachments/assets/bc264d5a-d926-47a3-a2a7-98010f7c2c8c"> ### 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*
1 parent aedf617 commit ce54461

File tree

1 file changed

+1
-0
lines changed
  • packages/aws-cdk-lib/aws-dynamodb/lib

1 file changed

+1
-0
lines changed

packages/aws-cdk-lib/aws-dynamodb/lib/table.ts

+1
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,7 @@ export interface TableOptions extends SchemaOptions {
347347
readonly replicationTimeout?: Duration;
348348

349349
/**
350+
* [WARNING: Use this flag with caution, misusing this flag may cause deleting existing replicas, refer to the detailed documentation for more information]
350351
* Indicates whether CloudFormation stack waits for replication to finish.
351352
* If set to false, the CloudFormation resource will mark the resource as
352353
* created and replication will be completed asynchronously. This property is

0 commit comments

Comments
 (0)