AWS documentdb documentation change
Summary
Updated documentation for Amazon DocumentDB global clusters with capitalization consistency ('region' to 'Region'), instance class updates (db.r6 to db.r6g), UI label corrections, and minor formatting changes.
Security assessment
Changes focus on terminology consistency (Region capitalization), instance class specifications (db.r6g instead of db.r6), and UI label updates. No mention of vulnerabilities, security patches, or new security features. Existing security-related elements like VPC security groups and encryption-at-rest remain unchanged in functionality.
Diff
diff --git a/documentdb/latest/developerguide/global-clusters.get-started.md index e4a090b83..40485ce80 100644 --- a/documentdb/latest/developerguide/global-clusters.get-started.md +++ b/documentdb/latest/developerguide/global-clusters.get-started.md @@ -5 +5 @@ -ConfigurationCreating a global clusterAdding a region to a global clusterUsing a snapshot +ConfigurationCreating a global clusterAdding a Region to a global clusterUsing a snapshot @@ -13 +14,3 @@ ConfigurationCreating a global clusterAdding a region to a global clusterUsing a - * Adding a region to a global cluster + + * Adding a Region to a global cluster + @@ -20 +24 @@ ConfigurationCreating a global clusterAdding a region to a global clusterUsing a -Amazon DocumentDB global cluster spans at least two AWS Regions. The primary region supports a cluster that has one primary (writer) instance and up to fifteen replica instances, while a secondary region runs a read-only cluster made up entirely of up to sixteen replica instances. A global cluster can have up to five secondary regions. The table lists the maximum clusters, instances, and replicas allowed in a global cluster. +Amazon DocumentDB global cluster spans at least two AWS Regions. The primary Region supports a cluster that has one primary (writer) instance and up to 15 replica instances, while a secondary Region runs a read-only cluster made up entirely of up to 16 replica instances. A global cluster can have up to five secondary Regions. The table lists the maximum clusters, instances, and replicas allowed in a global cluster. @@ -27 +31 @@ Read-only instances (Amazon DocumentDB replicas), per cluster | 15 (max) | 16 (t -Read-only instances (max allowed, given actual number of secondary regions) | 15 - _s_ | _s_ = total number of secondary AWS Regions +Read-only instances (max allowed, given actual number of secondary Regions) | 15 - _s_ | _s_ = total number of secondary AWS Regions @@ -31 +35 @@ The clusters have the following specific requirements: - * **Database instance class requirements** — You can only use the `db.r5` and `db.r6` instance classes. + * **Database instance class requirements** — You can only use the `db.r5` and `db.r6g` instance classes. @@ -33 +37 @@ The clusters have the following specific requirements: - * **AWS Region requirements** — The primary cluster must be in one region, and at least one secondary cluster must be in a different region of the same account. You can create up to five secondary (read-only) clusters, and each must be in a different region. In other words, no two clusters can be in the same region. + * **AWS Region requirements** — The primary cluster must be in one Region, and at least one secondary cluster must be in a different Region of the same account. You can create up to five secondary (read-only) clusters, and each must be in a different Region. In other words, no two clusters can be in the same Region. @@ -35 +39 @@ The clusters have the following specific requirements: - * **Naming requirements** — The names you choose for each of your clusters must be unique, across all regions. You can't use the same name for different clusters even though they're in different regions. + * **Naming requirements** — The names you choose for each of your clusters must be unique, across all Regions. You can't use the same name for different clusters even though they're in different Regions. @@ -70 +74 @@ Are you ready to build your first global cluster? In this section we will explai - 6. Choose **Show Advanced Settings**. + 6. Choose **Show advanced settings**. @@ -74 +78 @@ Are you ready to build your first global cluster? In this section we will explai - 7. In the **Network Settings** section: + 7. In the **Network settings** section: @@ -76 +80 @@ Are you ready to build your first global cluster? In this section we will explai - * Keep default options for **Virtual Private Cloud** and **Subnet Group**. + * Keep default options for **Virtual Private Cloud (VPC)** and **Subnet group**. @@ -78 +82 @@ Are you ready to build your first global cluster? In this section we will explai - + @@ -80 +84 @@ Are you ready to build your first global cluster? In this section we will explai - * For **VPC Security Groups** , **default VPC** should already be added. + * For **VPC security groups** , **default (VPC)** should already be added. @@ -82 +86 @@ Are you ready to build your first global cluster? In this section we will explai - + @@ -84 +88 @@ Are you ready to build your first global cluster? In this section we will explai - * Type `DocDB` into the **VPC Security Groups** field and select **DocDB-Inbound (VPC)**. + * Type `DocDB` into the **VPC security groups** field and select **DocDB-Inbound (VFC)**. @@ -88 +92 @@ Are you ready to build your first global cluster? In this section we will explai - 8. For **Cluster Options** and **Encryption-at-rest** , leave at default selections. + 8. For **Cluster options** and **Encryption-at-rest** , leave at default selections. @@ -92 +96 @@ Are you ready to build your first global cluster? In this section we will explai - 9. For **Backup** and **Log Exports** , leave at default selections. + 9. For **Backup** and **Log exports** , leave at default selections. @@ -96 +100 @@ Are you ready to build your first global cluster? In this section we will explai - 10. For **Maintenance** , **Tags** and **Deletion Protection** , leave default selections. + 10. For **Maintenance** , **Tags** , and **Deletion protection** , leave at default selections. @@ -100 +104 @@ Are you ready to build your first global cluster? In this section we will explai - 11. Now click the button that says **Create**. + 11. Now click the button that says **Create cluster**. @@ -102 +106 @@ Are you ready to build your first global cluster? In this section we will explai - + @@ -107 +111 @@ Are you ready to build your first global cluster? In this section we will explai -To create an Amazon DocumentDB regional cluster, call the [create-global-cluster AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-global-cluster.html). The following AWS CLI command creates an Amazon DocumentDB cluster named `global-cluster-id`. For more information on deletion protection, see [Deleting an Amazon DocumentDB cluster](./db-cluster-delete.html). +To create an Amazon DocumentDB Regional cluster, call the [create-global-cluster AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-global-cluster.html). The following AWS CLI command creates an Amazon DocumentDB cluster named `global-cluster-id`. For more information on deletion protection, see [Deleting an Amazon DocumentDB cluster](./db-cluster-delete.html). @@ -177 +181 @@ It takes several minutes to create the cluster. You can use the AWS Management C -When you use the AWS CLI to create an Amazon DocumentDB regional cluster, no instances are created. Consequently, you must explicitly create a primary instance and any replica instances that you need. You can use either the console or AWS CLI to create the instances. For more information, see [Adding an Amazon DocumentDB instance to a cluster](./db-instance-add.html) and [CreateDBCluster](./API_CreateDBCluster.html) in the Amazon DocumentDB API Reference. +When you use the AWS CLI to create an Amazon DocumentDB Regional cluster, no instances are created. Consequently, you must explicitly create a primary instance and any replica instances that you need. You can use either the console or AWS CLI to create the instances. For more information, see [Adding an Amazon DocumentDB instance to a cluster](./db-instance-add.html) and [CreateDBCluster](./API_CreateDBCluster.html) in the Amazon DocumentDB API Reference. @@ -179 +183 @@ When you use the AWS CLI to create an Amazon DocumentDB regional cluster, no ins -Once your regional cluster is available, you can add a secondary cluster in another region with the following instructions: Adding an AWS Region to an Amazon DocumentDB global cluster. When you add a region, your regional cluster becomes your primary cluster, and you have a new secondary cluster in the region you chose. +Once your Regional cluster is available, you can add a secondary cluster in another Region with the following instructions: Adding an AWS Region to an Amazon DocumentDB global cluster. When you add a Region, your Regional cluster becomes your primary cluster, and you have a new secondary cluster in the Region you chose. @@ -183 +187 @@ Once your regional cluster is available, you can add a secondary cluster in anot -A global cluster needs at least one secondary cluster in a different region than the primary cluster, and you can add up to five secondary clusters. Note that for each secondary cluster that you add, you must reduce the number of replicas allowed in the primary cluster by one. For example, if your global cluster has five secondary regions, your primary cluster can have only ten (rather than fifteen) replicas. For more information, see [Configuration requirements of an Amazon DocumentDB global cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/global-clusters.get-started.html#global-clusters.config). +A global cluster needs at least one secondary cluster in a different Region than the primary cluster, and you can add up to five secondary clusters. Note that for each secondary cluster that you add, you must reduce the number of replicas allowed in the primary cluster by one. For example, if your global cluster has five secondary Regions, your primary cluster can have only 10 (rather than 15) replicas. For more information, see [Configuration requirements of an Amazon DocumentDB global cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/global-clusters.get-started.html#global-clusters.config). @@ -195 +199 @@ A global cluster needs at least one secondary cluster in a different region than - 4. Select the drop down menu for **Actions** and then choose **Add region**. + 4. Select the dropdown list for **Actions** and then choose **Add Region**. @@ -199 +203 @@ A global cluster needs at least one secondary cluster in a different region than - 5. On the **Add a region** page, choose the secondary region. Note that you can't choose a region that already has a secondary cluster for the same global cluster. Also, it can't be the same region as the primary cluster. If this is the first region you are adding, you will also have to specify a global cluster identifier of your choice. + 5. On the **Add an AWS Region** page, choose the secondary Region. Note that you can't choose a Region that already has a secondary cluster for the same global cluster. Also, it can't be the same Region as the primary cluster. If this is the first Region you are adding, you will also have to specify a global cluster identifier of your choice. @@ -203 +207 @@ A global cluster needs at least one secondary cluster in a different region than - 6. Complete the remaining fields for the secondary cluster in the new region then select **Create Cluster**. After you finish adding the region, you can see it in the list of **Clusters** in the AWS Management Console. + 6. Complete the remaining fields for the secondary cluster in the new Region, then select **Create cluster**. After you finish adding the Region, you can see it in the list of **Clusters** in the AWS Management Console. @@ -212 +216 @@ A global cluster needs at least one secondary cluster in a different region than - * For `--region`, choose a different AWS Region than that of your primary region. + * For `--region`, choose a different AWS Region than that of your primary Region. @@ -263 +267 @@ For Windows: -You can restore a snapshot of an Amazon DocumentDB cluster to use as the starting point for your global cluster. To do this, you must restore the snapshot and create a new cluster. This will serve as the primary cluster of your global cluster. You can then add another region to the restored cluster, thus converting it into a global cluster. +You can restore a snapshot of an Amazon DocumentDB cluster to use as the starting point for your global cluster. To do this, you must restore the snapshot and create a new cluster. This will serve as the primary cluster of your global cluster. You can then add another Region to the restored cluster, thus converting it into a global cluster.