# Getting started with the AWS Toolkit for JetBrains
The AWS Toolkit for JetBrains makes your AWS services and resources available directly from your JetBrains integrated development environment (IDE).
To get you started, the following topics walk you through the processes of installing, setting up, and configuring the AWS Toolkit for JetBrains.
**Note**
To run the AWS Toolkit for JetBrains version 3.0 or later, you must also install AWS Core from the JetBrains Marketplace.
**Topics**
+ [Installing the AWS Toolkit](setup-toolkit.md)
+ [Installing custom builds and releases](setup-toolkit-eap.md)
+ [Navigation](navigation.md)
+ [Connecting to AWS](account-connect.md)
+ [AWS Regions](setup-region.md)
+ [HTTP proxy setup](setup-http-proxy.md)
# Installing the AWS Toolkit for JetBrains
You can download, install, and set up the AWS Toolkit for JetBrains from the JetBrains Marketplace in your IDE. Alternatively, you can download the latest AWS Toolkit for JetBrains installation files by navigating to the [AWS Toolkit for JetBrains Marketplace](https://plugins.jetbrains.com/plugin/11349-aws-toolkit) listing from your web browser.
**Note**
To run the AWS Toolkit for JetBrains version 3.0 or later, you must also install AWS Core from the JetBrains Marketplace.
The following sections describe how to install and set up the AWS Toolkit for JetBrains directly from your JetBrains IDE.
## Installing the AWS Toolkit from your JetBrains IDE
To download and install the AWS Toolkit for JetBrains directly from your preferred JetBrains IDE, complete the following procedure.
1. From the JetBrains main menu, open your **Preferences** menu (expand **File** choose **Settings**, for Windows users).
1. From the **Preferences**/**Settings** menu, choose **Plugins** to open the **Plugins** menu.
1. From the **Plugins** menu navigation, choose **Marketplace** to open the JetBrains Plugin **Marketplace**.
1. In the provided search field, enter **AWS Toolkit**.
1. From the **AWS Toolkit** plugin entry, choose the green **Install** button, next to the entry title.
1. Accept the **Third-party Plugins Privacy Notice** to continue with the installation process.
1. JetBrains prompts you to restart the IDE when installation is complete.
# Installing AWS Toolkit for JetBrains Early Access Program (EAP) and custom builds
Early Access Program (EAP) builds of the AWS Toolkit for JetBrains contain previews of new and experimental features.
**Note**
To run the AWS Toolkit for JetBrains version 3.0 or later, you must also install AWS Core from the JetBrains Marketplace.
To configure your toolkit for EAP builds, complete the following procedure:
1. From the JetBrains main menu, open your **Preferences** menu (expand **File** choose **Settings**, for Windows users).
1. From the **Preferences**/**Settings** menu, choose **Plugins** to open the **Plugins** menu.
1. From the **Plugins** menu navigation, expand the **Settings (Manage Repositories, Configure Proxy or Install Plugin from Disk)** icon and choose **Manage Plugin Repositories**.
1. From the **Manage Plugin Repositories** menu choose the **\$1 (Add)** icon and enter **https://plugins.jetbrains.com/plugins/eap/aws.toolkit** into the **EAP repository for the AWS Toolkit** field.
1. Choose **OK** to start the EAP installation.
1. JetBrains prompts you to restart the IDE when the installation is complete.
## Removing AWS Toolkit for JetBrains EAP and custom repository references
It may be necessary to remove an EAP or custom repository reference in order to use a specific version of the AWS Toolkit for JetBrains. To remove a repository reference, complete the following procedure.
**Note**
After completing this procedure it may still be necessary to uninstall your current version of the AWS Toolkit for JetBrains before updating or installing a different version.
**To remove an EAP repository reference**
1. From the JetBrains main menu, open your **Preferences** menu (expand **File** choose **Settings**, for Windows users).
1. From the **Preferences**/**Settings** menu, choose **Plugins** to open the **Plugins** menu.
1. From the **Plugins** menu navigation, expand the **Settings (Manage Repositories, Configure Proxy or Install Plugin from Disk)** icon and choose **Manage Plugin Repositories**.
1. From the **Manage Plugin Repositories** menu choose the **- (Remove)** icon and confirm the removal.
# Navigating the AWS Toolkit for JetBrains
The following topics describe the basic locations and components of the AWS Toolkit for JetBrains.
**Topics**
+ [
## Viewing the toolkit from JetBrains
](#w2aac13c15b7)
+ [
## The AWS Explorer
](#w2aac13c15b9)
+ [
## Connecting to AWS
](#w2aac13c15c11)
## Viewing the toolkit from JetBrains
To view the toolkit in your JetBrains IDE, complete the following steps:
1. From the JetBrains IDE, expand the **Active Toolbar** using the **Active Toolbar** icon located in the bottom left-hand corner of the JetBrains IDE.
1. From the **Active Toolbar** choose **AWS Toolkit**.
1. The AWS Toolkit for JetBrains is now open in the **Active Toolbar** window.
![\[IDE interface showing search options, project view, and file navigation shortcuts.\]](http://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/images/viewtoolkit2024.gif)
## The AWS Explorer
Your AWS services and resources are available through the AWS Toolkit for JetBrains Explorer.
**Note**
Your AWS services and resources are only visible from the AWS Explorer after you've set up authentication and connected to your AWS account.
For additional information about authentication and the AWS Toolkit for JetBrains, see the [Authentication and access](https://docs.aws.amazon.com//toolkit-for-jetbrains/latest/userguide/auth-access.html) table of contents in this User Guide.
For additional information about connecting to your AWS account from the AWS Toolkit for JetBrains, see the [Connecting to AWS](https://docs.aws.amazon.com//toolkit-for-jetbrains/latest/userguide/account-connect.html) topic in this User Guide.
To view your AWS services and resources from the AWS Toolkit for JetBrains Explorer:
1. From the AWS Toolkit for JetBrains choose the **Explorer** tab to view the AWS services associated with your account and region.
1. Select a service to expand a list of your resources.
1. Open the context menu for (right-click) a resource to see a list of features for modifying your resource.
![\[IntelliJ IDEA interface showing empty project structure and quick access options.\]](http://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/images/awsexplorer2024.gif)
## Connecting to AWS
Your connection and authentication settings can be added or updated from the **AWS Toolkit Sign In** panel. The following procedure describes how to access the **AWS Toolkit Sign In** panel.
**Note**
If this is the first time that you're using the Toolkit or no credentials are detected on start up, then the **AWS Toolkit Sign In** pane automatically opens in the JetBrains editor.
For detailed instructions on how to connect to your AWS account from the AWS Toolkit for JetBrains, see the [Connect to AWS](https://docs.aws.amazon.com//toolkit-for-jetbrains/latest/userguide/account-connect.html) topic in this User Guide.
1. From the Toolkit, open **AWS Connection Settings** by choosing the **ellipses** icon in the connection pane.
1. From **AWS Connection Settings**, choose **Setup Authentication...** to open the **AWS Toolkit Sign In** pane.
1. From the **AWS Toolkit Sign In** panel, select your authentication method and follow the on-screen prompts.
The following is an image of the AWS Sign In panel.
![\[AWS sign-in panel with options for Workforce single sign-on or IAM Credential local key storage.\]](http://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/images/awssigninpane2024.png)
# Connecting the AWS Toolkit for JetBrains to your AWS account
Most Amazon Web Services (AWS) and resources are managed through an AWS account. An AWS account isn't required to use the AWS Toolkit for JetBrains, 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 AWS Toolkit for JetBrains automatically detects your credentials and guides you through the connection process.
## Prerequisites
If you're new to AWS or haven't created an account, then there are 3 main steps to connect the AWS Toolkit for JetBrains with your AWS account:
1. **Signing up for an AWS account**: You can sign up for an AWS account from the [AWS sign up](https://portal.aws.amazon.com/billing/signup#/start/email) portal. For detailed information on setting up a new AWS account, see the [Overview](https://docs.aws.amazon.com//SetUp/latest/UserGuide/setup-overview.html) topic in the *AWS Setup User Guide*.
1. **Setting up authentication**: There are 3 primary methods to authenticate with your AWS account from the AWS Toolkit for JetBrains. To learn more about each of these methods, see the [Authentication and access](https://docs.aws.amazon.com//toolkit-for-jetbrains/latest/userguide/auth-access.html) topic in this User Guide.
1. **Connecting with your AWS account from the AWS Toolkit for JetBrains**: After you've created an AWS account and set up authentication, you can connect the AWS Toolkit for JetBrains with your AWS account by completing the *Connecting to AWS from the AWS Toolkit for JetBrains* procedure, located in the following section.
## Opening the Sign In panel
If this is your first time using the AWS Toolkit for JetBrains, the **AWS Toolkit Sign In** panel automatically opens in JetBrains.
To access the AWS Sign In panel at anytime, complete the following procedure.
1. From the Toolkit, open **AWS Connection Settings** by choosing the **ellipses** icon in the connection panel.
1. From **AWS Connection Settings**, choose **Setup Authentication...** to open the **AWS Toolkit Sign In** pane.
1. From the **AWS Toolkit Sign In** panel, select your authentication method and follow the on-screen prompts.
The following is an image of the **AWS Toolkit Sign In** panel.
![\[AWS Toolkit sign-in panel with options for Workforce single sign-on or IAM Credential local key storage.\]](http://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/images/awssigninpane2024.png)
## Connecting to AWS from the AWS Toolkit for JetBrains
The following sections describe how to authenticate and connect the AWS Toolkit for JetBrains with AWS to access the AWS Explorer and Amazon CodeCatalyst.
**Note**
Authentication with AWS Builder ID or IAM Identity Center launches the AWS authorization portal in your default web browser. Each time your credentials expire this process must be repeated to renew the connection between your AWS account and the AWS Toolkit for JetBrains.
### Authentication for the AWS Explorer
To get started working with the AWS Explorer in the Toolkit, authenticate and connect with either your IAM credentials or IAM Identity Center credentials.
The following procedures describe how to authenticate and connect the Toolkit with your AWS account.
**Authenticate and connect with IAM Identity Center**
1. From the **AWS Toolkit Sign In** panel, select the **Workforce** button, then choose the **Continue** button to advance to the **Sign in with SSO** screen.
1. From the **IAM Identity Center** screen, enter your **Profile Name**, **Start URL**, and select your **Region** in the drop down, then choose the **Continue** button to open the **AWS SSO Login Required** dialog.
**Note**
Choose the **Region** that matches the region associated with your IAM Identity Center credentials.
1. From the **AWS SSO Login Required** dialog, choose the **Proceed To Browser** button to open the **AWS Authorization request** website in your default web browser.
1. Follow the prompts in your default web browser, you're notified when the authorization process is complete, it is safe to return to close your browser, and return to JetBrains.
**Authenticate and connect with IAM Credentials**
1. From the **AWS Toolkit Sign In** panel, select the **IAM Credentials** button, then choose the **Continue** button to advance to the **IAM Credentials** screen.
1. From the **IAM Credentials** screen, enter your **Profile Name**, **Access Key**, and **Secret Key**, then choose the **Continue** button to add the profile to your config file and connect the Toolkit with your AWS account.
1. The AWS Explorer updates to display your AWS services and resources when authentication is complete.
## Authentication for Amazon CodeCatalyst
To get started working with CodeCatalyst from the Toolkit, authenticate and connect with your AWS Builder ID.
Complete the following steps to authenticate with your AWS account from the Toolkit, with your existing AWS Builder ID credentials.
**Authenticate and connect with an AWS Builder ID**
1. From the **AWS Toolkit Sign In** panel, select the **Workforce** button, then choose the **Continue** button to advance to the **Sign in with SSO** screen.
1. From the **Sign in with SSO** screen, choose the **Skip to sign-in** link to open the **AWS Authorization request** website in your default web browser.
1. Follow the prompts in your default web browser, you're notified when the authorization process is complete, it is safe to return to close your browser, and return to JetBrains.
**Authenticate and connect with IAM Identity Center**
1. From the **AWS Toolkit Sign In** panel, select the **Workforce** button, then choose the **Continue** button to advance to the **Sign in with SSO** screen.
1. From the **IAM Identity Center** screen, enter your **Profile Name**, **Start URL**, and select your **Region** in the drop down, then choose the **Continue** button to open the **AWS SSO Login Required** dialog.
**Note**
Choose the **Region** that matches the region associated with your IAM Identity Center credentials.
1. From the **AWS SSO Login Required** dialog, choose the **Proceed To Browser** button to open the **AWS Authorization request** website in your default web browser.
1. Follow the prompts in your default web browser, you're notified when the authorization process is complete, it is safe to return to close your browser, and return to JetBrains.
# Setting an AWS Region for the AWS Toolkit for JetBrains
An AWS Region specifies where your AWS resources are managed. Your default AWS Region is detected when you connect to your AWS account from the AWS Toolkit for JetBrains and automatically displays in the AWS Explorer.
The following sections describe how to view and change your Region from the AWS Toolkit for JetBrains Explorer.
## Viewing the current AWS Region
To check which AWS Region is currently selected, complete the following steps.
1. From the AWS Explorer, choose the **Settings** icon to open the **Show Options Menu**.
1. From the **Show Options Menu**, expand **AWS connection Settings** to display a list of AWS Regions that are available for your account.
1. Your current AWS Region displays a **check mark** icon, next to the region name.
## Changing AWS Regions
To change your current AWS Region complete the following steps.
1. From the AWS Explorer, choose the **Settings** icon to open the **Show Options Menu**.
1. From the **Show Options Menu**, expand **AWS connection Settings** to display a list of AWS Regions.
1. Choose the AWS Region you want to connect to, from the list.
**Note**
If you don't see the region you want to connect to, choose **All Regions** to open a complete list of all AWS regions.
# Setting up HTTP proxy for the AWS Toolkit for JetBrains
Setting an HTTP Proxy for the AWS Toolkit for JetBrains is handled through your JetBrains integrated development environment (IDE). To learn more about how to set an HTTP proxy, choose your JetBrains IDE from the following list.
+ **CLion** – See [Configure HTTP proxy](https://www.jetbrains.com/help/clion/configuring-http-proxy.html) on the CLion help website.
+ **GoLand** – See [HTTP Proxy](https://www.jetbrains.com/help/go/settings-http-proxy.html) on the GoLand help website.
+ **IntelliJ IDEA** – See [HTTP Proxy](https://www.jetbrains.com/help/idea/settings-http-proxy.html) on the IntelliJ IDEA help website.
+ **WebStorm** – See [HTTP Proxy](https://www.jetbrains.com/help/webstorm/settings-http-proxy.html) on the WebStorm help website.
+ **JetBrains Rider** – See [Configure HTTP Proxy](https://www.jetbrains.com/help/rider/Configuring_HTTP_Proxy.html) on the JetBrains Rider help website.
+ **PhpStorm** – See [HTTP Proxy](https://www.jetbrains.com/help/phpstorm/settings-http-proxy.html) on the PhpStorm help website.
+ **PyCharm** – See [HTTP Proxy](https://www.jetbrains.com/help/pycharm/settings-http-proxy.html) on the PyCharm help website.
+ **RubyMine** – See [HTTP Proxy](https://www.jetbrains.com/help/ruby/settings-http-proxy.html) on the RubyMine help website.