AWS amazondynamodb documentation change
Summary
Completely restructured the workflow for creating data models in NoSQL Workbench. Removed the template-based creation method and streamlined the process to start directly with table configuration. Updated steps for table creation, attribute addition, facet usage, and GSI creation. Added guidance recommending access patterns over facets for data modeling.
Security assessment
The changes are purely workflow improvements for NoSQL Workbench's modeling interface. There's no evidence of security vulnerability fixes, security incident references, or new security features. The modifications focus on usability improvements, updated screenshots, and revised instructions. The note about preferring access patterns over facets relates to data modeling best practices, not security.
Diff
diff --git a/amazondynamodb/latest/developerguide/workbench.Modeler.CreateNew.md b/amazondynamodb/latest/developerguide/workbench.Modeler.CreateNew.md index 06ab23afd..e90522c0b 100644 --- a//amazondynamodb/latest/developerguide/workbench.Modeler.CreateNew.md +++ b//amazondynamodb/latest/developerguide/workbench.Modeler.CreateNew.md @@ -11 +11 @@ Follow these steps to create a new data model in Amazon DynamoDB using NoSQL Wor - 1. Open NoSQL Workbench, and in the navigation pane on the left side, choose the **Data modeler** icon. + 1. Open NoSQL Workbench, and on the main screen, select **Create model manually**. @@ -13 +13 @@ Follow these steps to create a new data model in Amazon DynamoDB using NoSQL Wor - +A new page will open with an empty configuration for your first table. NoSQL Workbench creates all new data models with a default name (i.e. untitled-2) and adds them to the **Drafts** project folder. @@ -15 +15 @@ Follow these steps to create a new data model in Amazon DynamoDB using NoSQL Wor - 2. Choose **Create data model**. + 2. On **Table configuration screen** , specify the following: @@ -17 +17 @@ Follow these steps to create a new data model in Amazon DynamoDB using NoSQL Wor - + * **Table name** — Enter a unique name for the table. @@ -19 +19 @@ Follow these steps to create a new data model in Amazon DynamoDB using NoSQL Wor -**Create data model** has two choices: Make model from scratch and Start from a template. + * **Partition key** — Enter a partition key name, and specify its type. Optionally, you can also select a more granular data type format for sample data generation. @@ -21,41 +21 @@ Follow these steps to create a new data model in Amazon DynamoDB using NoSQL Wor - - -Make model from scratch - - -To make a model from scratch, enter a name, author, and description for the data model. Choose **Create** when finished. - - - -Start from a template - - -Starting from a template lets you choose a sample model to start from. Choose **More templates** to see more template options. Choose **Select** for the template that you want to use. - -Enter a data model name, author, and description for the template you selected. You can choose between **Schema only** and **Schema with sample data**. - - * **Schema only** creates an empty data model with the primary key (partition and sort key) and other attributes. - - * **Schema with sample data** will create a data model complete with sample data for the primary key (partition and sort key) and other attributes. - -When this information is complete, choose **Create** to create the model. - - - - 3. With the model created, choose **Add table**. - - - -For more information about tables, see [Working with tables in DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html). - - 4. Specify the following: - - * **Table name** – Enter a unique name for the table. - - * **Partition key** – Enter a partition key name, and specify its type. Optionally, you can also select a more granular data type format for sample data generation. - - * If you want to add a sort key: - - 1. Select **Add sort key**. - - 2. Specify the sort key name and its type. Optionally, you can select a more granular data type format for sample data generation. + * If you want to add a **Sort key** , specify the sort key name and its type. Optionally, you can select a more granular data type format for sample data generation. @@ -73 +33 @@ To learn more about primary key design, designing and using partition keys effec - 5. To add other attributes, do the following for each attribute: + 3. You can add other attributes to more clearly validate your model and access patterns. To add other attributes: @@ -75 +35 @@ To learn more about primary key design, designing and using partition keys effec - 1. Choose **Add an attribute**. + * Choose **Add an attribute**. @@ -77 +37 @@ To learn more about primary key design, designing and using partition keys effec - 2. Specify the attribute name and its type. Optionally, you can select a more granular data type format for sample data generation. + * Specify the attribute name and its type. @@ -79 +39 @@ To learn more about primary key design, designing and using partition keys effec - 6. Add a facet: + * Optionally, you can select a more granular data type format for sample data generation. @@ -81 +41 @@ To learn more about primary key design, designing and using partition keys effec -You can optionally add a facet. A facet is a virtual construct in NoSQL Workbench. It is not a functional construct in DynamoDB itself. + 4. If you want to add a global secondary index, choose **Add global secondary index**. Specify the **Global secondary index name** , **Partition key** attribute, and **Projection type**. @@ -83,5 +43 @@ You can optionally add a facet. A facet is a virtual construct in NoSQL Workbenc -###### Note - -_Facets_ in NoSQL Workbench help you visualize an application's different data access patterns for Amazon DynamoDB with only a subset of the data in a table. To learn more about facets, see [Viewing data access patterns](./workbench.Visualizer.Facets.html). - -To add a facet, +For more information about working with global secondary indexes in DynamoDB, see [Global secondary indexes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.html). @@ -89 +45 @@ To add a facet, - * Select **Add facets**. + 5. Optionally, **Add a facet**. A facet is a virtual construct in NoSQL Workbench. It is not a functional construct in DynamoDB. Facets in NoSQL Workbench help you visualize an application's different data access patterns for DynamoDB with only a subset of the data in a table. @@ -91 +47 @@ To add a facet, - * Choose **Add facet**. +###### Note @@ -93 +49 @@ To add a facet, - +We recommend you use [Adding and validating access patterns](./workbench.Modeler.AccessPatterns.html) to visualize how your application will access data in DynamoDB instead of Facets. Access patterns mirror your actual database interactions and help you build the correct data model for your use case, while facets are non-functional visualizations. @@ -95 +51 @@ To add a facet, - * Specify the following: +Choose **Add facet**. Specify the following: @@ -101 +57 @@ To add a facet, - * A **Sort key alias**. + * A **Sort key alias** if you provided a **Sort key** for the table. @@ -103,5 +59 @@ To add a facet, - * Choose the **Other attributes** that are part of this facet. - -Choose **Add facet**. - - + * Choose the **Attributes** that are part of this facet. @@ -111,11 +63 @@ Repeat this step if you want to add more facets. - 7. If you want to add a global secondary index, choose **Add global secondary index**. - -Specify the **Global secondary index name** , **Partition key** attribute, and **Projection type**. - - - -For more information about working with global secondary indexes in DynamoDB, see [Global secondary indexes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.html). - - 8. Save the edits to your table settings.. - - + 6. Finally, click the **Save** button to create the table. @@ -122,0 +65 @@ For more information about working with global secondary indexes in DynamoDB, se + 7. If you need other **Tables** or **Global Secondary Indexes** , click on the **+** icon above the table you just created. @@ -126 +68,0 @@ For more information about working with global secondary indexes in DynamoDB, se -For more information about the `CreateTable` API operation, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the _Amazon DynamoDB API Reference_.