AWS amazondynamodb documentation change
Summary
Updated tutorial to include creating global tables with Multi-Region Eventual Consistency (MREC) and Multi-Region Strong Consistency (MRSC), added detailed steps for both modes, included IAM policy examples, and added a section on global tables security.
Security assessment
The changes add documentation for MRSC's strong consistency model and IAM policy requirements, which are security-related features that improve data integrity and access control. The new 'Global tables security' section explicitly adds security documentation. However, there is no evidence these changes address a specific security vulnerability or incident.
Diff
diff --git a/amazondynamodb/latest/developerguide/V2globaltables.tutorial.md b/amazondynamodb/latest/developerguide/V2globaltables.tutorial.md index 480390bc2..bd54eeef2 100644 --- a//amazondynamodb/latest/developerguide/V2globaltables.tutorial.md +++ b//amazondynamodb/latest/developerguide/V2globaltables.tutorial.md @@ -5 +5 @@ -# Tutorial: Creating a global table +Creating a global table configured for MRECCreating a global table configured for MRSC @@ -7 +7,5 @@ -This section describes how to create a global table using the Amazon DynamoDB console or the AWS Command Line Interface (AWS CLI). +# Tutorials: Creating global tables + +This section provides step-by-step instructions for creating DynamoDB global tables with different consistency mode. Choose either Multi-Region Eventual Consistency (MREC) or Multi-Region Strong Consistency (MRSC) modes based on your application's requirements. + +MREC global tables provide lower write latency with eventual consistency across AWS Regions. MRSC global tables provide strongly consistent reads across Regions with slightly higher write latencies than MREC. Choose the consistency mode that best meets your application's needs for data consistency, latency, and availability. @@ -10,0 +15,5 @@ This section describes how to create a global table using the Amazon DynamoDB co + * Creating a global table configured for MREC + + * Creating a global table configured for MRSC + + @@ -12,0 +22 @@ This section describes how to create a global table using the Amazon DynamoDB co +## Creating a global table configured for MREC @@ -14 +24 @@ This section describes how to create a global table using the Amazon DynamoDB co -Follow these steps to create a global table using the AWS Management Console. The following example creates a global table with replica tables in United States and Europe. +This section shows how to create a global table with Multi-Region Eventual Consistency (MREC) mode. MREC is the default consistency mode for global tables and provides low-latency writes with asynchronous replication across AWS Regions. Changes made to an item in one region are typically replicated to all other regions within a second. This makes MREC ideal for applications that prioritize low write latency and can tolerate brief periods where different Regions may return slightly different versions of data. @@ -16 +26 @@ Follow these steps to create a global table using the AWS Management Console. Th - 1. Open the DynamoDB console at [https://console.aws.amazon.com/dynamodb/home](https://console.aws.amazon.com/dynamodb/home). For this example, choose the **US East (Ohio)** Region. +You can create MREC global tables with replicas in any AWS Region where DynamoDB is available and add or remove replicas at any time. The following examples show how to create an MREC global table with replicas in multiple regions. @@ -18 +28 @@ Follow these steps to create a global table using the AWS Management Console. Th - 2. In the navigation pane on the left side of the console, choose **Tables**. +Follow these steps to create a global table using the AWS Management Console. The following example creates a global table with replica tables in the United States and Europe. @@ -20 +30 @@ Follow these steps to create a global table using the AWS Management Console. Th - 3. Choose **Create Table**. + 1. Sign in to the AWS Management Console and open the DynamoDB console at [https://console.aws.amazon.com/dynamodb/](https://console.aws.amazon.com/dynamodb/). @@ -22 +32,7 @@ Follow these steps to create a global table using the AWS Management Console. Th - 4. On the **Create table** page, do the following: + 2. For this example, choose **US East (Ohio)** from the Region selector in the navigation bar. + + 3. In the navigation pane on the left side of the console, choose **Tables**. + + 4. Choose **Create Table**. + + 5. On the **Create table** page: @@ -30 +46 @@ Follow these steps to create a global table using the AWS Management Console. Th - 4. Keep the default selection of **String** for both **Partition key** and **Sort key**. + 4. Keep the other default settings and choose **Create table**. @@ -32 +48 @@ Follow these steps to create a global table using the AWS Management Console. Th - 5. Keep the other default selections on the page, and then choose **Create table**. +This new table serves as the first replica table in a new global table. It is the prototype for other replica tables that you add later. @@ -34 +50 @@ Follow these steps to create a global table using the AWS Management Console. Th -This new table serves as the first replica table in a new global table. It's the prototype for other replica tables that you add later. + 6. After the table becomes active: @@ -36 +52 @@ This new table serves as the first replica table in a new global table. It's the - 5. On the **Tables** page, choose the newly created **Music** table, then do the following: + 1. Select the **Music** table from the tables list. @@ -38 +54 @@ This new table serves as the first replica table in a new global table. It's the - 1. Choose the **Global tables** tab, and then choose **Create replica**. + 2. Choose the **Global tables** tab. @@ -40 +56 @@ This new table serves as the first replica table in a new global table. It's the - 2. In the **Available replication Regions** dropdown list, choose **US West (Oregon) us-west-2**. + 3. Choose **Create replica**. @@ -42 +58 @@ This new table serves as the first replica table in a new global table. It's the -The console checks to make sure that a table with the same name doesn't exist in the selected Region. If a table with the same name does exist, you must delete the existing table before you can create a new replica table in that Region. + 7. From the **Available replication Regions** dropdown list, choose **US West (Oregon) us-west-2**. @@ -44 +60,3 @@ The console checks to make sure that a table with the same name doesn't exist in - 3. Choose **Create replica**. This starts the table creation process in the US West (Oregon) us-west-2 Region. +The console ensures that a table with the same name doesn't exist in the selected Region. If a table with the same name does exist, you must delete the existing table before you can create a new replica table in that Region. + + 8. Choose **Create replica**. This starts the table creation process in the US West (Oregon) us-west-2 Region. @@ -48 +66,22 @@ The **Global tables** tab for the **Music** table (and for any other replica tab - 4. Add another Region so that your global table is replicated and synchronized across the United States and Europe. To do this, repeat step 5.b, but this time, specify **Europe (Frankfurt) eu-central-1** instead of **US West (Oregon) us-west-2**. + 9. Add another region by repeating the previous steps, but choose **Europe (Frankfurt) eu-central-1** as the region. + + 10. To test replication: + + 1. Make sure you're using the AWS Management Console in the US East (Ohio) Region. + + 2. Choose **Explore table items**. + + 3. Choose **Create item**. + + 4. Enter `item_1` for **Artist** and `Song Value 1` for **SongTitle**. + + 5. Choose **Create item**. + + 11. Verify replication by switching to the other regions: + + 1. From the Region selector in the upper-right corner, choose **Europe (Frankfurt)**. + + 2. Verify that the **Music** table contains the item you created. + + 3. Repeat the verification for **US West (Oregon)**. + @@ -50 +88,0 @@ The **Global tables** tab for the **Music** table (and for any other replica tab - 6. Make sure that you're still using the AWS Management Console in the US East (Ohio) Region. Then, do the following: @@ -52 +89,0 @@ The **Global tables** tab for the **Music** table (and for any other replica tab - 1. Choose **Explore table items**. @@ -54 +91 @@ The **Global tables** tab for the **Music** table (and for any other replica tab - 2. Choose **Create item**. +The following code example shows how to manage DynamoDB global tables with multi-Region replication with eventual consistency (MREC). @@ -56 +93 @@ The **Global tables** tab for the **Music** table (and for any other replica tab - 3. For **Artist** , enter `item_1`. + * Create a table with multi-Region replication (MREC). @@ -58 +95 @@ The **Global tables** tab for the **Music** table (and for any other replica tab - 4. For **SongTitle** , enter `Song Value 1`. + * Put and get items from replica tables. @@ -60 +97 @@ The **Global tables** tab for the **Music** table (and for any other replica tab - 5. To save the item, choose **Create item**. + * Remove replicas one-by-one. @@ -62 +99 @@ The **Global tables** tab for the **Music** table (and for any other replica tab - 7. After a short time, the item is replicated across all three Regions of your global table. To verify this, in the console, on the Region selector in the upper-right corner, choose **Europe (Frankfurt)**. The **Music** table in Europe (Frankfurt) should contain the new item. + * Clean up by deleting the table. @@ -64 +100,0 @@ The **Global tables** tab for the **Music** table (and for any other replica tab - 8. Repeat step 7 and choose **US West (Oregon)** to verify replication in that Region. @@ -67,0 +104 @@ The **Global tables** tab for the **Music** table (and for any other replica tab +Bash @@ -69 +105,0 @@ The **Global tables** tab for the **Music** table (and for any other replica tab -Follow these steps to create a global table `Music` using the AWS CLI. The following example creates a global table, with replica tables in the United States and in Europe. @@ -71 +107 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo - 1. Create a new table (`Music`) in US East (Ohio), with DynamoDB Streams enabled (`NEW_AND_OLD_IMAGES`). +**AWS CLI with Bash script** @@ -72,0 +109,5 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo + +Create a table with multi-Region replication. + + + # Step 1: Create a new table (MusicTable) in US East (Ohio), with DynamoDB Streams enabled (NEW_AND_OLD_IMAGES) @@ -74 +115 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo - --table-name Music \ + --table-name MusicTable \ @@ -85,3 +126,2 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo - 2. Create an identical `Music` table in US East (N. Virginia). - - aws dynamodb update-table --table-name Music --cli-input-json \ + # Step 2: Create an identical MusicTable table in US East (N. Virginia) + aws dynamodb update-table --table-name MusicTable --cli-input-json \ @@ -98 +138,17 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo - --region=us-east-2 + --region us-east-2 + + # Step 3: Create a table in Europe (Ireland) + aws dynamodb update-table --table-name MusicTable --cli-input-json \ + '{ + "ReplicaUpdates": + [ + { + "Create": { + "RegionName": "eu-west-1" + } + } + ] + }' \ + --region us-east-2 + + @@ -100 +156 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo - 3. Repeat step 2 to create a table in Europe (Ireland) (eu-west-1). +Describe the multi-Region table. @@ -102 +157,0 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo - 4. You can view the list of replicas created using `describe-table`. @@ -104 +159,5 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo - aws dynamodb describe-table --table-name Music --region us-east-2 + # Step 4: View the list of replicas created using describe-table + aws dynamodb describe-table \ + --table-name MusicTable \ + --region us-east-2 \ + --query 'Table.{TableName:TableName,TableStatus:TableStatus,MultiRegionConsistency:MultiRegionConsistency,Replicas:Replicas[*].{Region:RegionName,Status:ReplicaStatus}}' @@ -106 +164,0 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo - 5. To verify that replication is working, add a new item to the `Music` table in US East (Ohio). @@ -107,0 +166,5 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo + +Put items in a replica table. + + + # Step 5: To verify that replication is working, add a new item to the Music table in US East (Ohio) @@ -109 +172 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo - --table-name Music \ + --table-name MusicTable \ @@ -113 +175,0 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo - 6. Wait for a few seconds, and then check to see whether the item has been successfully replicated to US East (N. Virginia) and Europe (Ireland). @@ -114,0 +177,6 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo + +Get items from replica tables. + + + # Step 6: Wait for a few seconds, and then check to see whether the item has been + # successfully replicated to US East (N. Virginia) and Europe (Ireland) @@ -116 +184 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo - --table-name Music \ + --table-name MusicTable \ @@ -121 +189 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo - --table-name Music \ + --table-name MusicTable \ @@ -125 +192,0 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo - 7. Delete the replica table in Europe (Ireland) Region. @@ -127 +194,6 @@ Follow these steps to create a global table `Music` using the AWS CLI. The follo - aws dynamodb update-table --table-name Music --cli-input-json \ + +Remove replicas. +