AWS prescriptive-guidance documentation change
Summary
Updated documentation links, corrected punctuation/formatting, and standardized DynamoDB references. Changed markdown table formatting and removed backticks from API method names.
Security assessment
Changes are editorial improvements (punctuation fixes, URL updates, formatting consistency) without any security-specific content. No references to vulnerabilities, security controls, or security best practices were added/modified.
Diff
diff --git a/prescriptive-guidance/latest/modernization-rdbms-dynamodb/overview.md b/prescriptive-guidance/latest/modernization-rdbms-dynamodb/overview.md index f7803f87a..77bd06a67 100644 --- a//prescriptive-guidance/latest/modernization-rdbms-dynamodb/overview.md +++ b//prescriptive-guidance/latest/modernization-rdbms-dynamodb/overview.md @@ -5 +5 @@ -[Documentation](/index.html)[AWS Prescriptive Guidance](https://aws.amazon.com/prescriptive-guidance/)[Modernizing your application by migrating from an RDBMS to Amazon DynamoDB](welcome.html) +[Documentation](/index.html)[AWS Prescriptive Guidance](https://aws.amazon.com/prescriptive-guidance/)[Modernizing your application by migrating from an RDBMS to Amazon DynamoDB](introduction.html) @@ -17 +17 @@ The schemaless nature of NoSQL databases helps reduce the time and process requi -DynamoDB provides the following features and benefits: +Amazon DynamoDB provides the following features and benefits: @@ -19 +19 @@ DynamoDB provides the following features and benefits: - * No servers to manage – DynamoDB is a fully managed NoSQL database service, which means that it doesn’t involve any server maintenance overhead. + * No servers to manage – DynamoDB is a fully managed NoSQL database service, which means that it doesn't involve any server maintenance overhead. @@ -39 +39 @@ DynamoDB provides the following features and benefits: - * Global secondary indexes – You can query your DynamoDB table by using partition and sort keys that are different from the table’s own partition and sort keys. + * Global secondary indexes – You can query your DynamoDB table by using partition and sort keys that are different from the table's own partition and sort keys. @@ -52 +52 @@ For more information about these benefits, see [Amazon DynamoDB Features](https: -DynamoDB is schemaless, so it’s not necessary to define all attributes for a table. The partition key attribute is required, and the sort key is optional. The rest of the attributes are arbitrary and can vary per item. We recommend that you choose a partition key with high cardinality so that frequently accessed items don’t reside on the same partition. This practice helps you avoid data access imbalances and hot partitions. For more information, see [Best practices for designing and using partition keys effectively](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html) in the DynamoDB documentation. +DynamoDB is schemaless, so it's not necessary to define all attributes for a table. The partition key attribute is required, and the sort key is optional. The rest of the attributes are arbitrary and can vary per item. We recommend that you choose a partition key with high cardinality so that frequently accessed items don't reside on the same partition. This practice helps you avoid data access imbalances and hot partitions. For more information, see [Best practices for designing and using partition keys effectively](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html) in the DynamoDB documentation. @@ -56 +56 @@ DynamoDB is schemaless, so it’s not necessary to define all attributes for a t -Indexes give you access to alternate query patterns and can speed up queries. You should create indexes carefully, regardless of whether you’re using a relational database or DynamoDB. Whenever a write operation occurs on a table, all the indexes for that table must be updated. +Indexes give you access to alternate query patterns and can speed up queries. You should create indexes carefully, regardless of whether you're using a relational database or DynamoDB. Whenever a write operation occurs on a table, all the indexes for that table must be updated. @@ -58 +58 @@ Indexes give you access to alternate query patterns and can speed up queries. Yo -A global secondary index contains a selection of attributes from the base table, but they are organized by a primary key that is different from the table’s own primary key. In DynamoDB, global secondary indexes are sparse by default. That is, the sort key is optional and doesn’t appear in every table item. To take advantage of this feature, you can create global secondary indexes that store and project only the required attributes. You can have up to 20 global secondary indexes on a DynamoDB table. For more information about this feature, see [Using global secondary indexes in DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.html) in the DynamoDB documentation. +A global secondary index contains a selection of attributes from the base table, but they are organized by a primary key that is different from the table's own primary key. In DynamoDB, global secondary indexes are sparse by default. That is, the sort key is optional and doesn't appear in every table item. To take advantage of this feature, you can create global secondary indexes that store and project only the required attributes. You can have up to 20 global secondary indexes on a DynamoDB table. For more information about this feature, see [Using global secondary indexes in DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.html) in the DynamoDB documentation. @@ -68 +68 @@ DynamoDB offers two pricing models to choose from: provisioned capacity and on-d -**Pricing model** | **Workload type** | **Cost** | **Read/write throughput** +Pricing model| Workload type| Cost| Read/write throughput @@ -76 +76 @@ You can enable automatic scaling to adjust capacity in response to traffic chang -On-demand capacity | Dynamic | Higher | You don’t specify throughput requirements. DynamoDB accommodates your workloads automatically. You’re charged for the reads and writes that your application performs on your tables in terms of read request units and write request units. For example: +On-demand capacity| Dynamic| Higher| You don't specify throughput requirements. DynamoDB accommodates your workloads automatically.You're charged for the reads and writes that your application performs on your tables in terms of read request units and write request units. For example: @@ -88 +88 @@ DynamoDB supports atomicity, consistency, isolation, and durability (ACID) trans -To manage changes to multiple items within and across tables, you can use the DynamoDB transactional `TransactWriteItems` and `TransactGetItems` APIs. +To manage changes to multiple items within and across tables, you can use the DynamoDB transactional TransactWriteItems and TransactGetItems APIs. @@ -90 +90 @@ To manage changes to multiple items within and across tables, you can use the Dy - * `TransactWriteItems` is a batch operation that contains a write set with one or more `PutItem`, `UpdateItem`, and `DeleteItem` actions. `TransactWriteItems` can optionally check for prerequisite conditions that must be satisfied before making updates. These conditions might involve the same items as those in the write set, or different items. If any condition isn’t met, the transaction is rejected. + * TransactWriteItems is a batch operation that contains a write set with one or more PutItem, UpdateItem, and DeleteItem actions. TransactWriteItems can optionally check for prerequisite conditions that must be satisfied before making updates. These conditions might involve the same items as those in the write set, or different items. If any condition isn't met, the transaction is rejected. @@ -92 +92 @@ To manage changes to multiple items within and across tables, you can use the Dy - * `TransactGetItems` is a batch operation that contains a read set with one or more `GetItem` actions. If you issue a `TransactGetItems` request on an item that is part of an active write transaction, the read transaction is canceled. To get the previously committed value, you can use a standard read operation. + * TransactGetItems is a batch operation that contains a read set with one or more GetItem actions. If you issue a TransactGetItems request on an item that is part of an active write transaction, the read transaction is canceled. To get the previously committed value, you can use a standard read operation. @@ -107 +107 @@ DynamoDB transactional API operations have the following constraints: - * No two actions in a transaction can work against the same item in the same table. For example, you cannot run both `ConditionCheck` and `Update` actions on the same item in one transaction. + * No two actions in a transaction can work against the same item in the same table. For example, you cannot run both ConditionCheck and Update actions on the same item in one transaction. @@ -113 +113 @@ DynamoDB transactional API operations have the following constraints: - * The object persistence model doesn’t support transactions. To use the transaction feature, you must access the database and tables using the [DynamoDB low-level API](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.LowLevelAPI.html). + * The object persistence model doesn't support transactions. To use the transaction feature, you must access the database and tables using the [DynamoDB low-level API](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.LowLevelAPI.html). @@ -122 +122 @@ DynamoDB has a size limit of 400 KB for each item. This limit includes both attr -**Workaround** +**Workaround:** @@ -124 +124 @@ DynamoDB has a size limit of 400 KB for each item. This limit includes both attr -If an item is associated with many attributes and properties, or a large amount of data, its size might exceed 400 KB. In this case, you can store the serialized item in Amazon Simple Storage Service (Amazon S3) in JSON format, and save the Amazon S3 location as an attribute (`S3Location`) in the item. Read and write operations for that item fetch the S3 object and update the JSON string. The primary key, sort key, and all attributes used by local indexes and global secondary indexes should be stored in the table along with the `S3Location` attribute. This requires additional logic in the application (data access layer) to check for the `S3Location` attribute and to fetch the complete item data from Amazon S3. +If an item is associated with many attributes and properties, or a large amount of data, its size might exceed 400 KB. In this case, you can store the serialized item in Amazon Simple Storage Service (Amazon S3) in JSON format, and save the Amazon S3 location as an attribute (S3Location) in the item. Read and write operations for that item fetch the S3 object and update the JSON string. The primary key, sort key, and all attributes used by local indexes and global secondary indexes should be stored in the table along with the S3Location attribute. This requires additional logic in the application (data access layer) to check for the S3Location attribute and to fetch the complete item data from Amazon S3. @@ -128 +128 @@ If an item is associated with many attributes and properties, or a large amount -Backup and restore support is a common feature expectation in any database. DynamoDB natively supports backup and restore operations within the same account, but you can perform table copy across multiple accounts by using other options or processes. These processes do not consume any read/write capacity units. For more information, see the guide [Cross-account full table copy options for Amazon DynamoDB](https://docs.aws.amazon.com/prescriptive-guidance/latest/dynamodb-full-table-copy-options/welcome.html) on the AWS Prescriptive Guidance website. +Backup and restore support is a common feature expectation in any database. DynamoDB natively supports backup and restore within the same account, but you can perform table copy across multiple accounts by using other options or processes. These processes do not consume any read/write capacity units. For more information, see the guide [Cross-account full table copy options for Amazon DynamoDB](https://docs.aws.amazon.com/prescriptive-guidance/latest/dynamodb-full-table-copy-options/welcome.html) on the AWS Prescriptive Guidance website. @@ -132 +132 @@ Backup and restore support is a common feature expectation in any database. Dyna -DynamoDB currently supports cross-account backup and restore by using [AWS Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html), but the account has to be part of the same organization. You can address this limitation by adopting one of the following solutions: +DynamoDB currently supports cross-account backup and restore using AWS Backup, but the account has to be part of the same organization. You can address this limitation by adopting one of the following solutions: @@ -134 +134 @@ DynamoDB currently supports cross-account backup and restore by using [AWS Backu - * Custom implementation in a programming language of your choice (for example, .NET, Java, or Python) by using an [AWS SDK](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GettingStarted.html). You can scan items from the source table in account A and write items (`BatchWrite`) to a table in account B. You can run this code on the server, on an on-premises computer, or in AWS Lambda (if the database is small and is the script takes less than 15 minutes to run). For more information, see the pattern [Copy Amazon DynamoDB tables across accounts using a custom implementation](https://docs.aws.amazon.com/prescriptive-guidance/latest/patterns/copy-amazon-dynamodb-tables-across-accounts-using-a-custom-implementation.html) on the AWS Prescriptive Guidance website. + * Custom implementation in a programming language of your choice (for example, .NET, Java, or Python) by using an [AWS SDK](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GettingStarted.html). You can scan items from the source table in account A and write items (BatchWrite) to a table in account B. You can run this code on the server, on an on-premises computer, or in AWS Lambda (if the database is small and is the script takes less than 15 minutes to run). For more information, see the pattern [Copy Amazon DynamoDB tables across accounts using a custom implementation](https://docs.aws.amazon.com/prescriptive-guidance/latest/patterns/copy-amazon-dynamodb-tables-across-accounts-using-a-custom-implementation.html) on the AWS Prescriptive Guidance website.