Connecting to AWS
Most Amazon Web Services (AWS) services and resources are managed through an AWS account. An AWS account isn't required to use the AWS Toolkit for Visual Studio, however Toolkit functions are limited without a connection.
If you've previously set up an AWS account and authentication through another AWS service (such as the AWS Command Line Interface), then the Toolkit for Visual Studio automatically detects your credentials.
Prerequisites
If you're new to AWS or haven't created an account, then there are 3 main steps to connect the Toolkit for Visual Studio with your AWS account:
-
Signing up for an AWS account: You can sign up for an AWS account from the AWS sign up portal
. For detailed information on setting up a new AWS account, see the Overview topic in the AWS Setup User Guide. -
Setting up authentication: There are 3 primary methods to authenticate with your AWS 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.
-
Authenticating with AWS from the Toolkit: You can connect with your AWS account from the Toolkit by completing the procedures in the following sections of this User Guide.
Connecting to AWS from the Toolkit
To connect to your AWS accounts from the Toolkit for Visual Studio, open the Getting Started with the AWS Toolkit User Interface (connection UI) by completing the following procedure.
-
From the Visual Studio main menu, expand Extensions then expand the AWS Toolkit.
-
From the AWS Toolkit menu options choose Getting Started.
-
The Getting Started with the AWS 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, AWS IAM Identity Center, AWS Identity and Access Management credentials, and AWS 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 AWS Builder ID when cloning a 3rd party repository.
Amazon Q Developer | AWS Explorer | Amazon CodeCatalyst |
---|---|---|
☑ AWS Builder ID ☑ IAM Identity Center ☒ AWS IAM credentials |
☒ AWS Builder ID ☑ IAM Identity Center ☑ AWS IAM credentials |
☑ AWS Builder ID ☒ IAM Identity Center ☒ AWS IAM credentials |
Authentication for Amazon Q Developer
To get started with Amazon Q Developer, authenticate and connect with your AWS IAM Identity Center or AWS Builder ID credentials.
The following procedures describe how to authenticate and connect the Toolkit with your AWS account.
Authenticate and connect with IAM Identity Center
-
From the Getting Started with the AWS 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.
-
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.
-
From the Profile Type drop-down menu, choose AWS IAM Identity Center
-
In the Profile Name text field, enter the
Profile Name
of the IAM Identity Center profile you want to authenticate with. -
In the Start URL text field, enter the
Start URL
that's attached to your IAM Identity Center credentials. -
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.
-
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 AWS IAM Identity Center dialog.
-
From the Log in with AWS IAM Identity Center dialog, choose the Proceed to Browser button to open the AWS Authorize request site in your default web browser.
-
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 AWS Builder ID
-
From the Getting Started with the AWS Toolkit connection UI, select the Amazon Q Developer radial to expand the Amazon Q Developer authentication options.
-
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 AWS Builder ID dialog.
-
Choose the Proceed to Browser button to open the AWS Authorize request site in your default web browser.
-
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 AWS Explorer
To get started working with the AWS 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 AWS account.
Authenticate and connect with IAM Identity Center
-
From the Getting Started with the AWS Toolkit connection UI, select the AWS Explorer radial to expand the Amazon Q Developer authentication options.
-
From the
Profile Type
drop-down menu, choose AWS IAM Identity Center. -
In the Profile Name text field, enter the
Profile Name
of the IAM Identity Center profile you want to use. -
In the Start URL text field, enter the
Start URL
that's attached to your IAM Identity Center credentials. -
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.
-
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.
-
Choose the Proceed to browser button to open the AWS Authorize request site in your default web browser.
-
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
-
From the Getting Started with the AWS Toolkit connection UI, select the AWS Explorer radial to expand the Amazon Q Developer authentication options.
-
From the
Profile Type
drop-down menu, choose IAM User Role. -
In the Profile Name text field, enter the
Profile Name
of the profile you want to authenticate with. -
In the Access Key ID text field, enter the
Access Key ID
for the profile you want to authenticate with. -
In the Secret Key text field, enter the
Secret Key
for the profile you want to authenticate with. -
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.
-
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.