feat(dynamodb): Implement importing existing dynamodb table.

Closes #3895.
aws · Dec 3, 2019 · 3b3fa61 · 3b3fa61
1 parent 1dcba75
commit 3b3fa61
Show file tree

Hide file tree

Showing 3 changed files with 437 additions and 112 deletions.
diff --git a/packages/@aws-cdk/aws-dynamodb/README.md b/packages/@aws-cdk/aws-dynamodb/README.md
@@ -19,6 +19,22 @@ const table = new dynamodb.Table(this, 'Table', {
 });
 ```
 
+### Importing existing tables
+
+To import an existing table into your CDK application, use the `Table.fromTableAttributes`
+factory method. This method accepts `TableAttributes` which describes the properties of an already
+existing table:
+
+```ts
+const table = Table.fromTableAttributes(this, 'ImportedTable', {
+    tableArn: 'arn:aws:dynamodb:::table/my-table',
+    hasIndex: true
+});
+
+// now you can just call methods on the table
+table.grantReadWriteData(user);
+```
+
 ### Keys
 
 When a table is defined, you must define it's schema using the `partitionKey`