AWS Security ChangesHomeSearch

AWS res: Grammar and wording cleanup in RES prerequisites guide

Service: res · 2026-09-29 · Documentation low

File: res/archive/release-minus-2/ug/prerequisites.md

Summary

Copyediting of the Research and Engineering Studio prerequisites page: capitalization fixes (Optional -> optional), article/grammar corrections, 'we recommend' changed to 'as a best practice', and a typo fix of PrivateKeySecretArn to PrivateKeySecretARN. No substantive technical or security content changed.

Security assessment

The only line touching a security-relevant concept (a secret ARN and tags granting vdc-gateway access) is merely a casing typo fix (PrivateKeySecretArn -> PrivateKeySecretARN); it does not change any permission, policy, or guidance. All other edits are stylistic grammar/capitalization changes with no security impact.

Evidence

-  4. In the GovCloud partition account, create a secret with the value of the `PrivateKeySecretArn` output. Note the new secret ARN and add two tags to the secret so `vdc-gateway` can access the secret value: 

Diff

diff --git a/res/archive/release-minus-2/ug/prerequisites.md b/res/archive/release-minus-2/ug/prerequisites.md
index 638e51b40..7e9683bf9 100644
--- a//res/archive/release-minus-2/ug/prerequisites.md
+++ b//res/archive/release-minus-2/ug/prerequisites.md
@@ -7 +7 @@
-Create an AWS account with an administrative userCreate an Amazon EC2 SSH key pairIncrease service quotasCreate a Cognito user pool (Optional)Create a custom domain (optional)Create domain (GovCloud only)Provide external resourcesConfigure LDAPS in your environment (optional)Service Account for Microsoft Active DirectoryConfigure a private VPC (optional)
+Create an AWS account with an administrative userCreate an Amazon EC2 SSH key pairIncrease service quotasCreate a Cognito user pool (optional)Create a custom domain (optional)Create a domain (GovCloud only)Provide external resourcesConfigure LDAPS in your environment (optional)Service Account for Microsoft Active DirectoryConfigure a private VPC (optional)
@@ -19 +19 @@ Create an AWS account with an administrative userCreate an Amazon EC2 SSH key pa
-  * Create a Cognito user pool (Optional)
+  * Create a Cognito user pool (optional)
@@ -23 +23 @@ Create an AWS account with an administrative userCreate an Amazon EC2 SSH key pa
-  * Create domain (GovCloud only)
+  * Create a domain (GovCloud only)
@@ -53 +53 @@ When you sign up for an AWS account, an _AWS account root user_ is created. The
-If you do not have Amazon EC2 SSH key pair, you will need to create one. For more information, see [Create a key pair using Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html) in the _Amazon EC2 User Guide_. 
+If you do not have an Amazon EC2 SSH key pair, you must create one. For more information, see [Create a key pair using Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html) in the _Amazon EC2 User Guide_. 
@@ -57 +57 @@ If you do not have Amazon EC2 SSH key pair, you will need to create one. For mor
-We recommend [increasing the service quotas](https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html) for:
+As a best practice, [increase the service quotas](https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html) for:
@@ -67 +67 @@ We recommend [increasing the service quotas](https://docs.aws.amazon.com/service
-    * Increase the EC2-VPC Elastic IPs from five to ten
+    * Increase the EC2-VPC Elastic IPs from five to ten.
@@ -72 +72 @@ We recommend [increasing the service quotas](https://docs.aws.amazon.com/service
-Your AWS account has default quotas, formerly referred to as limits, for each AWS service. Unless otherwise noted, each quota is Region-specific. You can request increases for some quotas, and other quotas cannot be increased. For more information, see [Quotas for AWS services in this product](./plan-your-deployment.html#quotas-for-aws-services-in-this-product).
+Your AWS account has default quotas for each AWS service. Unless otherwise noted, each quota is Region-specific. You can request increases for some quotas, and other quotas cannot be increased. For more information, see [Quotas for AWS services in this product](./plan-your-deployment.html#quotas-for-aws-services-in-this-product).
@@ -74 +74 @@ Your AWS account has default quotas, formerly referred to as limits, for each AW
-## Create a Cognito user pool (Optional)
+## Create a Cognito user pool (optional)
@@ -76 +76 @@ Your AWS account has default quotas, formerly referred to as limits, for each AW
-You have the option to import an existing Cognito User Pool for user and client authentication when you install RES. Otherwise, RES will create a new Cognito User Pool automatically. The pre-existing User Pool needs to have the following sign-up custom attributes:
+You have the option to import an existing Cognito User Pool for user and client authentication when you install RES. Otherwise, RES will create a new Cognito User Pool automatically. The pre-existing user pool must have the following sign-up custom attributes:
@@ -88 +88 @@ custom:uid | Number | 2000200001 | 4294967294 | TRUE
-We recommend using a custom domain for the product in order to have a user-friendly URL. You may provide a custom domain and _optionally_ provide a certificate for it. 
+As a best practice, use a custom domain for the product for a user-friendly URL. You can provide a custom domain and _optionally_ provide a certificate for it. 
@@ -96 +96 @@ Or, follow these steps to register a domain using Amazon Route 53 and import a c
-  2. Retrieve the hosted zone for your domain. This is created automatically by Route53.
+  2. Retrieve the hosted zone for your domain. Route 53 creates this automatically.
@@ -117 +117 @@ Or, follow these steps to register a domain using Amazon Route 53 and import a c
-## Create domain (GovCloud only)
+## Create a domain (GovCloud only)
@@ -119 +119 @@ Or, follow these steps to register a domain using Amazon Route 53 and import a c
-If you are deploying in an AWS GovCloud Region and you are using a custom domain for Research and Engineering Studio, you will need to complete these prerequisite steps.
+If you are deploying in an AWS GovCloud Region and you are using a custom domain for Research and Engineering Studio, you must complete these prerequisite steps.
@@ -131 +131 @@ If you are deploying in an AWS GovCloud Region and you are using a custom domain
-  4. In the GovCloud partition account, create a secret with the value of the `PrivateKeySecretArn` output. Note the new secret ARN and add two tags to the secret so `vdc-gateway` can access the secret value: 
+  4. In the GovCloud partition account, create a secret with the value of the `PrivateKeySecretARN` output. Note the new secret ARN and add two tags to the secret so `vdc-gateway` can access the secret value: 
@@ -171 +171 @@ If you are deploying a demo environment and do not have these external resources
-For demo deployments in the an AWS GovCloud Region, you will need to complete the prerequisite steps in Create domain (GovCloud only).
+For demo deployments in an AWS GovCloud Region, you must complete the prerequisite steps in Create a domain (GovCloud only).