Connecting to Amazon - Amazon Toolkit for Visual Studio
PrerequisitesConnecting to Amazon from the ToolkitAuthentication for Amazon Q DeveloperAuthentication for the Amazon Explorer
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Connecting to Amazon

Most Amazon Web Services (Amazon) services and resources are managed through an Amazon account. An Amazon account isn't required to use the Amazon Toolkit for Visual Studio, however Toolkit functions are limited without a connection.

If you've previously set up an Amazon account and authentication through another Amazon service (such as the Amazon Command Line Interface), then the Toolkit for Visual Studio automatically detects your credentials.

Prerequisites

If you're new to Amazon or haven't created an account, then there are 3 main steps to connect the Toolkit for Visual Studio with your Amazon account:

  1. Signing up for an Amazon account: You can sign up for an Amazon account from the Amazon sign up portal. For detailed information on setting up a new Amazon account, see the Overview topic in the Amazon Setup User Guide.

  2. Setting up authentication: There are 3 primary methods to authenticate with your Amazon account from the Toolkit for Visual Studio. To learn more about each of these methods, see the Authentication and Access topic in this User Guide.

  3. Authenticating with Amazon from the Toolkit: You can connect with your Amazon account from the Toolkit by completing the procedures in the following sections of this User Guide.

Connecting to Amazon from the Toolkit

To connect to your Amazon accounts from the Toolkit for Visual Studio, open the Getting Started with the Amazon Toolkit User Interface (connection UI) by completing the following procedure.

  1. From the Visual Studio main menu, expand Extensions then expand the Amazon Toolkit.

  2. From the Amazon Toolkit menu options choose Getting Started.

  3. The Getting Started with the Amazon Toolkit connection UI opens in Visual Studio.

The following table describes which authentication methods are compatible with each feature. To learn more about each of the 3 authentication methods, Amazon IAM Identity Center, Amazon Identity and Access Management credentials, and Amazon Builder ID, see the Authentication and access table of contents in this User Guide.

Note

At present when working with CodeCatalyst in the Toolkit for Visual Studio, you're only required to authorize with your Amazon Builder ID when cloning a 3rd party repository.

Amazon Q Developer Amazon Explorer Amazon CodeCatalyst

☑ Amazon Builder ID

☑ IAM Identity Center

☒ Amazon IAM credentials

☒ Amazon Builder ID

☑ IAM Identity Center

☑ Amazon IAM credentials

☑ Amazon Builder ID

☒ IAM Identity Center

☒ Amazon IAM credentials

Authentication for Amazon Q Developer

To get started with Amazon Q Developer, authenticate and connect with your Amazon IAM Identity Center or Amazon Builder ID credentials.

The following procedures describe how to authenticate and connect the Toolkit with your Amazon account.

Authenticate and connect with IAM Identity Center

  1. From the Getting Started with the Amazon Toolkit connection UI, select the Amazon Q Developer radial to expand the Amazon Q Developer authentication options.

    Note

    If no stored credentials exist, proceed to Step 3 to add or update your IAM Identity Center credentials.

  2. From the My organization has enabled Amazon Q Developer section, expand the Choose from an existing Profile or add new drop-down menu to choose from your list of stored credentials.

  3. From the Profile Type drop-down menu, choose Amazon IAM Identity Center

  4. In the Profile Name text field, enter the Profile Name of the IAM Identity Center profile you want to authenticate with.

  5. In the Start URL text field, enter the Start URL that's attached to your IAM Identity Center credentials.

  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.

  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, then choose the Connect button to open the Log in with Amazon IAM Identity Center dialog.

  8. From the Log in with Amazon IAM Identity Center dialog, choose the Proceed to Browser button to open the Amazon Authorize request site in your default web browser.

  9. Confirm the security code in your IDE matches the Amazon Authorize request confirmation code displayed in your web browser and choose the Submit and continue button to proceed.

  10. 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.

Authenticate and connect with an Amazon Builder ID

  1. From the Getting Started with the Amazon Toolkit connection UI, select the Amazon Q Developer radial to expand the Amazon Q Developer authentication options.

  2. From the I'm using Amazon Q Developer on my own section, choose the Sign up or Sign in button to open the Log in with Amazon Builder ID dialog.

  3. Choose the Proceed to Browser button to open the Amazon Authorize request site in your default web browser.

  4. Confirm the security code in your IDE matches the Amazon Authorize request confirmation code displayed in your web browser and choose the Submit and continue button to proceed.

  5. 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.

Authentication for the Amazon Explorer

To get started working with the Amazon Explorer from the Toolkit, authenticate and connect with either your IAM Identity Center credentials or IAM credentials.

The following procedures describe how to authenticate and connect the Toolkit with your Amazon account.

Authenticate and connect with IAM Identity Center

  1. From the Getting Started with the Amazon Toolkit connection UI, select the Amazon Explorer radial to expand the Amazon Q Developer authentication options.

  2. From the Profile Type drop-down menu, choose Amazon IAM Identity Center.

  3. In the Profile Name text field, enter the Profile Name of the IAM Identity Center profile you want to use.

  4. In the Start URL text field, enter the Start URL that's attached to your IAM Identity Center credentials.

  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 SSO Region (defaults to us-east-1) drop-down menu, choose the SSO Region that's defined by your IAM Identity Center credentials.

  7. Choose the Proceed to browser button to open the Amazon Authorize request site in your default web browser.

  8. Confirm the security code in your IDE matches the Amazon Authorize request confirmation code displayed in your web browser and choose the Submit and continue button to proceed.

  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.

Authenticate and connect with IAM Credentials

  1. From the Getting Started with the Amazon Toolkit connection UI, select the Amazon Explorer radial to expand the Amazon Q Developer authentication options.

  2. From the Profile Type drop-down menu, choose IAM User Role.

  3. In the Profile Name text field, enter the Profile Name of the profile you want to authenticate with.

  4. In the Access Key ID text field, enter the Access Key ID for the profile you want to authenticate with.

  5. In the Secret Key text field, enter the Secret Key for the profile you want to authenticate with.

  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 Stored.

  7. From the Profile Region (defaults to us-east-1) drop-down menu, choose the Profile Region that's attached to the profile you want to authenticate with.