AWS toolkit-for-visual-studio documentation change
Summary
Updated authentication setup steps for Amazon Q and AWS Toolkit, including navigation flow changes and step renumbering. Added explicit references to 'Setup authentication' screens and adjusted browser authorization confirmation steps.
Security assessment
Changes focus on improving user guidance for authentication workflows but do not address specific vulnerabilities or introduce new security features. Modifications involve UI navigation and procedural clarity rather than security controls.
Diff
diff --git a/toolkit-for-visual-studio/latest/user-guide/connect.md b/toolkit-for-visual-studio/latest/user-guide/connect.md index 679865362..53f66ec3c 100644 --- a//toolkit-for-visual-studio/latest/user-guide/connect.md +++ b//toolkit-for-visual-studio/latest/user-guide/connect.md @@ -68 +68 @@ The **Profile Name** , **Start URL** , **Profile Region** , or **SSO Region** fi - 1. From the Professional tier section, fill in the required fields and choose the **Connect** button. + 1. From the **Getting Started: AWS Toolkit with Amazon Q** screen, choose the **Sign in** button in the Amazon Q tile to navigate to the **Setup authentication for Amazon Q** screen. @@ -70 +70 @@ The **Profile Name** , **Start URL** , **Profile Region** , or **SSO Region** fi - 2. Confirm that you want to open the AWS Authorize request portal in your default web browser. + 2. From the **Setup authentication for Amazon Q** screen, navigate to the **Professional tier** section, fill in the required fields and choose the **Connect** button. @@ -72 +72 @@ The **Profile Name** , **Start URL** , **Profile Region** , or **SSO Region** fi - 3. Complete the steps required by the AWS Authorize request portal, you're notified when it's safe to close your browser and return to Visual Studio + 3. Confirm that you want to open the AWS Authorize request portal in your default web browser. @@ -74 +74,3 @@ The **Profile Name** , **Start URL** , **Profile Region** , or **SSO Region** fi - 4. In the **Getting Started** tab, Amazon Q updates to show you're connected with IAM Identity Center when the process is complete. + 4. Complete the steps required by the AWS Authorize request portal, you're notified when it's safe to close your browser and return to Visual Studio + + 5. In the **Getting Started** tab, Amazon Q updates to show you're connected with IAM Identity Center when the process is complete. @@ -85 +87,3 @@ For additional details about AWS Builder ID, see the [Sign in with AWS Builder I - 1. From the **Free Tier** section, choose the **Sign up or Sign in** button. + 1. From the **Getting Started: AWS Toolkit with Amazon Q** screen, choose the **Sign in** button in the Amazon Q tile to navigate to the **Setup authentication for Amazon Q** screen. + + 2. From the **Setup authentication for Amazon Q** screen, navigate to the **Free Tier** section and choose the **Sign up or Sign in** button. @@ -87 +91 @@ For additional details about AWS Builder ID, see the [Sign in with AWS Builder I - 2. Confirm that you want to open the AWS Authorize request portal in your default web browser. + 3. Confirm that you want to open the AWS Authorize request portal in your default web browser. @@ -89 +93 @@ For additional details about AWS Builder ID, see the [Sign in with AWS Builder I - 3. Complete the steps required by the AWS Authorize request portal, you're notified when it's safe to close your browser and return to Visual Studio. + 4. Complete the steps required by the AWS Authorize request portal, you're notified when it's safe to close your browser and return to Visual Studio. @@ -91 +95 @@ For additional details about AWS Builder ID, see the [Sign in with AWS Builder I - 4. In the **Getting Started** tab, Amazon Q updates to show you're connected with your AWS Builder ID when the process is complete. + 5. In the **Getting Started** tab, Amazon Q updates to show you're connected with your AWS Builder ID when the process is complete. @@ -117 +121 @@ For detailed information about IAM Identity Center credentials, see the [What is - 1. From the **Setup Authentication for AWS Toolkit** screen, choose **IAM Identity Center (Successor to Single Sign-on)** from the **Profile Type** drop-down menu. + 1. From the **Getting Started: AWS Toolkit with Amazon Q** screen, choose the **Sign in** button in the AWS Toolkit tile to navigate to the **Setup authentication for AWS Toolkit** screen. @@ -119 +123,3 @@ For detailed information about IAM Identity Center credentials, see the [What is - 2. From the **Choose from an existing Profile or add new** drop-down menu, choose an existing profile or select **Add new profile** to add new profile information. + 2. From the **Setup Authentication for AWS Toolkit** screen, choose **IAM Identity Center (Successor to Single Sign-on)** from the **Profile Type** drop-down menu. + + 3. From the **Choose from an existing Profile or add new** drop-down menu, choose an existing profile or select **Add new profile** to add new profile information. @@ -125 +131 @@ If you choose an existing profile, go to step 7. - 3. In the **Profile Name** field, enter the `profile name` associated with the IAM Identity Center account that you want to authenticate with. + 4. In the **Profile Name** field, enter the `profile name` associated with the IAM Identity Center account that you want to authenticate with. @@ -127 +133 @@ If you choose an existing profile, go to step 7. - 4. In the **Start URL** text field, enter the `Start URL` that's attached to your IAM Identity Center credentials. + 5. In the **Start URL** text field, enter the `Start URL` that's attached to your IAM Identity Center credentials. @@ -129 +135 @@ If you choose an existing profile, go to step 7. - 5. From the **Profile Region (defaults to us-east-1)** drop-down menu, choose the **Profile Region** that's defined by the IAM Identity Center user profile you're authenticating with. + 6. From the **Profile Region (defaults to us-east-1)** drop-down menu, choose the **Profile Region** that's defined by the IAM Identity Center user profile you're authenticating with. @@ -131 +137 @@ If you choose an existing profile, go to step 7. - 6. From the **SSO Region (defaults to us-east-1)** drop-down menu, choose the **SSO Region** that's defined by your IAM Identity Center credentials. + 7. From the **SSO Region (defaults to us-east-1)** drop-down menu, choose the **SSO Region** that's defined by your IAM Identity Center credentials. @@ -133 +139 @@ If you choose an existing profile, go to step 7. - 7. Choose the **Connect** button to open the **AWS Authorize request** site in your default web browser. + 8. Choose the **Connect** button to open the **AWS Authorize request** site in your default web browser. @@ -135 +141 @@ If you choose an existing profile, go to step 7. - 8. Follow the prompts in your default web browser, you're notified when the authorization process is complete, it's safe to close your browser, and return to Visual Studio. + 9. Follow the prompts in your default web browser, you're notified when the authorization process is complete, it's safe to close your browser, and return to Visual Studio. @@ -137 +143 @@ If you choose an existing profile, go to step 7. - 9. In the **Getting Started** tab, the AWS Toolkit section updates to show you're connected with IAM Identity Center when the process is complete. + 10. In the **Getting Started** tab, the AWS Toolkit section updates to show you're connected with IAM Identity Center when the process is complete. @@ -144 +150,3 @@ If you choose an existing profile, go to step 7. - 1. From the **Setup authentication for AWS Toolkit** screen, choose **IAM User Role** from the **Profile Type** drop-down menu. + 1. From the **Getting Started: AWS Toolkit with Amazon Q** screen, choose the **Sign in** button in the AWS Toolkit tile to navigate to the **Setup authentication for AWS Toolkit** screen. + + 2. From the **Setup authentication for AWS Toolkit** screen, choose **IAM User Role** from the **Profile Type** drop-down menu. @@ -146 +154 @@ If you choose an existing profile, go to step 7. - 2. In the **Choose from an existing Profile or add new** drop-down menu, choose `Add new profile`. + 3. In the **Choose from an existing Profile or add new** drop-down menu, choose `Add new profile`. @@ -152 +160 @@ If you're choosing an existing profile name from the list, skip to **Step 8**. - 3. In the **Profile Name** text field, enter a name for your new profile. + 4. In the **Profile Name** text field, enter a name for your new profile. @@ -154 +162 @@ If you're choosing an existing profile name from the list, skip to **Step 8**. - 4. In the **Access Key ID** text field, enter the `Access Key ID` for the profile you want to authenticate with. + 5. In the **Access Key ID** text field, enter the `Access Key ID` for the profile you want to authenticate with. @@ -156 +164 @@ If you're choosing an existing profile name from the list, skip to **Step 8**. - 5. In the **Secret Key** text field, enter the `Secret Key` for the profile you want to authenticate with. + 6. In the **Secret Key** text field, enter the `Secret Key` for the profile you want to authenticate with. @@ -158 +166 @@ If you're choosing an existing profile name from the list, skip to **Step 8**. - 6. From the **Storage Location (defaults to Shared Credentials File)** drop-down menu, specify whether you want to store your credentials with a **Shared Credentials** file or with **.NET Encrypted Store**. + 7. From the **Storage Location (defaults to Shared Credentials File)** drop-down menu, specify whether you want to store your credentials with a **Shared Credentials** file or with **.NET Encrypted Store**. @@ -160 +168 @@ If you're choosing an existing profile name from the list, skip to **Step 8**. - 7. From the **Profile Region (defaults to us-east-1)** drop-down menus, choose the **Partition** and **Profile Region** that are attached to the profile you want to authenticate with. + 8. From the **Profile Region (defaults to us-east-1)** drop-down menus, choose the **Partition** and **Profile Region** that are attached to the profile you want to authenticate with. @@ -162 +170 @@ If you're choosing an existing profile name from the list, skip to **Step 8**. - 8. Choose the **Connect** button to add this profile to your AWS storage location and/or authenticate with AWS. + 9. Choose the **Connect** button to add this profile to your AWS storage location and/or authenticate with AWS. @@ -164 +172 @@ If you're choosing an existing profile name from the list, skip to **Step 8**. - 9. In the **Getting Started** tab, the AWS Toolkit section updates to show you're connected with your IAM User role credentials when the process is complete. + 10. In the **Getting Started** tab, the AWS Toolkit section updates to show you're connected with your IAM User role credentials when the process is complete.