AWS Toolkit for JetBrains
User Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Installing the AWS Toolkit for JetBrains

Install the AWS Toolkit for JetBrains as follows.

  1. Create an AWS account, if you don't have an account already.

  2. Create an administrator user and group in AWS Identity and Access Management (IAM) in the account, if you haven't done that already.

    Note

    We recommend that you create or use a special type of user and group in the account for the AWS Toolkit for JetBrains to use, which we call an administrator IAM user and group. Although you can create a regular IAM user and group in the account for the toolkit to use, this approach might not allow the toolkit to have full access to all of the AWS resources and AWS serverless applications in that account. We support, but strongly discourage, using an AWS account root user with the AWS Toolkit for JetBrains.

  3. Create an access key for the user, if you don't have an access key for that user already.

    Note

    An access key contains both an access key ID value and a secret access key value. The AWS Toolkit for JetBrains needs to use both of these values later. Be sure to store them in a secure location. If you lose them, they're gone forever and can't be retrieved. However, you can always delete a lost access key, and then create a replacement access key. If you ever do this, you also need to change your toolkit connection settings. We support, but strongly discourage, creating an access key for an AWS account root user for the AWS Toolkit for JetBrains to use.

  4. Ensure that IntelliJ IDEA or PyCharm 2018.3 or later is installed and running.

  5. For macOS, on the main menu, choose IntelliJ IDEA, Preferences or PyCharm, Preferences.

    For Windows and other operating systems, on the main menu, choose File, Settings.

  6. Choose Plugins.

  7. On the Marketplace tab, in Search plugins in marketplace, begin entering AWS Toolkit. When AWS Toolkit by Amazon Web Servicesis displayed, choose it.

    
        Finding the AWS Toolkit

    Note: AWS Toolkit is also available online at plugins.jetbrains.com

  8. Choose Install.

    
        Installing the AWS Toolkit for JetBrains
  9. When the Third-party Plugins Privacy Note is displayed, choose Accept.

  10. Choose Restart IDE.

  11. When prompted, choose Restart.

  12. Before you can use the AWS Toolkit for JetBrains to develop, test, analyze, and deploy AWS serverless applications or AWS Lambda functions, you must first also install the following tools, if you haven't done so already. These tools must be installed in the following order:

    1. AWS Command Line Interface (AWS CLI)

    2. Docker (Docker must always be running whenever you develop, test, analyze, or deploy serverless applications or functions)

    3. AWS Serverless Application Model Command Line Interface (AWS SAM CLI)

  13. After you install the AWS Toolkit for JetBrains (and, if you're working with AWS serverless applications or Lambda functions, you've installed the preceding additional required tools, in order), connect to an AWS account for the first time.