设置 AWS TToolkit for JetBrains - AWS Toolkit for JetBrains

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

设置 AWS TToolkit for JetBrains

要使用适用于 JetBrains 的 AWS 工具包访问 AWS 账户,您必须先将工具包连接到该账户。有两种选项可用于连接到您的帐户:

  • 添加访问密钥以指定账户的 AWS 证书。

  • 为将使用 AWS Single Sign-On 登录的账户添加命名配置文件 (AWS SSO)。

完成以下过程以建立初始连接、在连接之间切换、更改连接、删除连接等。

访问凭证文件

您应已经具有安装 AWS Toolkit for JetBrains。根据您的连接选项,您必须完成以下先决条件:

  • AWS 安全凭证 — 创建了访问密钥(其中包含访问密钥 ID值和私有访问密钥值),或 AWS 账户根用户(我们强烈建议这样做)。如果您没有 IAM 中用户的访问密钥,请创建一个

  • AWS SSO — 通过启用 AWS SSO、管理您的身份源以及向 AWS 账户分配 SSO 访问来配置单点登录。有关此过程的更多信息,请参阅入门的章节AWS Single Sign-On 用户指南

注意

我们建议将敏感凭据信息(如包含访问密钥的命名配置文件)存储在credentials文件。不太敏感的配置选项(如使用 AWS SSO 进行身份验证的命名配置文件)通常存储在config文件。

您可以将所有命名配置文件存储在一个文件中。如果您使用的是credentialsconfig文件,credentials在 IDE 中默认打开。

如果两个文件中都有共享相同名称的配置文件的凭证,则credentials优先级。有关更多信息,请参阅 。配置和凭证文件设置中的AWS 命令行界面用户指南

  • 要打开凭证以进行编辑,请执行下列操作之一:

    • 在状态栏上,选择AWS:未选择凭证,然后选择编辑 AWS 凭证文件

      
            AWS 在状态栏上没有选择凭证
      
            从状态栏编辑 AWS 凭证
    • 打开 AWS Explorer(如果尚未打开)。选择配置 AWS 连接,然后选择编辑 AWS 凭证文件

      
            从 AWS Explorer 配置 AWS 连接
      
            从 AWS Explorer 编辑 AWS 凭证

打开证书文件后,您可以对其进行编辑,以便使用访问密钥或 AWS SSO 指定对 AWS 账户的访问权限。

Connect with access keys
  1. 在文件中的 [default] 下,对于 aws_access_key_id,将 [accessKey1] 替换为访问密钥 ID 值(例如 AKIAIOSFODNN7EXAMPLE)。

    如果出现提示,请选择无论如何,我想编辑这个文件,然后选择确定

  2. 对于 aws_secret_access_key,将 [secretKey1] 替换为秘密访问密钥值(例如 wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY)。

    最终结果应如此处所示,遵循指定的配置文件格式。

    ... Other file contents omitted for brevity ... [default] # ... Some comments ... aws_access_key_id = AKIAIOSFODNN7EXAMPLE # ... Some more comments ... # ... Some more comments ... # ... Some more comments ... # ... Some more comments ... aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY ... Other file contents omitted for brevity ...
    注意

    适用于 JetBrains 的 AWS 工具包目前支持以下配置变量:

    • aws_access_key_id

    • aws_secret_access_key

    • aws_session_token

    • credential_process

    • external_id

    • mfa_serial

    • role_arn

    • source_profile

    有关更多信息,请参阅 。AWS CLI 配置变量中的AWS CLI 命令参考

  3. 保存该文件,然后将其关闭。适用于 JetBrains 的 AWS 工具包尝试使用前面的访问密钥连接到账户。

    连接后,您可以使用该工具包处理该账户中的 AWS 资源,例如AWS 无服务器的应用程序,AWS Lambda函数,AWS CloudFormation堆栈。

Connect with AWS SSO

使用 AWS SSO,您可以在credentials文件或config用于检索 AWS 账户的临时证书。配置文件定义指定 SSO门户以及与请求访问的用户关联的 AWS 账户和 IAM 角色。

适用于 JetBrains 的 AWS 工具包调用 AWS CLIlogin命令。(您添加的命名配置文件将作为一个选项传递给login)。如果登录成功,则会启动您的默认浏览器并验证您的 AWS SSO 登录。然后,您可以开始访问您账户中可用的 AWS 资源。

  1. credentials/config下的文件[default]中,为命名配置文件添加模板。

    您可以使用类似下面的示例作为典型 AWS SSO 配置文件的模板。

    重要

    对于命名配置文件,credentials文件使用的命名格式与config文件。包含前缀词profile仅当在config文件。在 credentials 文件中创建条目时,请勿 使用单词 profile

    ... Named profile in credentials file ... [default] sso_start_url = https://my-sso-portal.awsapps.com/start sso_region = us-east-1 sso_account_id = 123456789011 sso_role_name = readOnly region = us-west-2 ... Named profile in config file ... [profile user1] sso_start_url = https://my-sso-portal.awsapps.com/start sso_region = us-east-1 sso_account_id = 123456789011 sso_role_name = readOnly region = us-west-2 ... Other file contents omitted for brevity ...
  2. 为特定于 SSO 配置的密钥分配值:

    • sso_start_url— 指定指向组织的 AWS SSO 用户门户的 URL。

    • sso_region— 指定包含 AWS SSO 门户主机的 AWS 区域。它与 AWS 认的region参数。

    • sso_account_id— 指定 AWS 账户 ID,其中包含的 IAM 角色具有您希望授予关联 AWS SSO 用户的权限。

    • sso_role_name— 指定 IAM 角色的友好名称,该名称用于定义使用此配置文件通过 AWS SSO 获取凭证时的用户权限。

    • regionIAM 指定包含 AWS SSO 门户主机的 AWS 区域。它与 AWS 认的region参数。

    注意

    您还可以包括任何其他密钥和值在.aws/credentials file之外的压缩算法(例如output或者S3。但是,您不能包含任何凭证相关值,例如role_arn或者aws_secret_access_key。如果您这样做,AWS CLI 会生成错误。

    有关更多信息,请参阅 。配置 AWS CLI 以使用 AWS Single Sign-On中的AWS 命令行界面用户指南

    在适用于 JetBrains 的 AWS 工具包调用 AWS SSO 之后login命令时,会启动一个浏览器窗口以确认 SSO 登录成功。

您还可以有多个可用的连接,以便能在它们之间切换

在您连接后,适用于 JetBrains 的 AWS 工具包将自动选择默认 AWS 区域。您可能需要切换以使用位于不同区域中的不同的 AWS 资源

获取当前连接

要检查适用于 JetBrains 的 AWS 工具包当前使用的连接,请执行下列操作之一:

  • 在状态栏上,查看显示在AWS 连接设置Are”。

    
        状态栏中的当前连接
  • 打开 AWS Explorer(如果尚未打开),然后选择Show Options 菜单(设置图标)。选择AWS 连接设置。已选择当前连接。

    
        AWS Explorer 中的当前连接

您还可以有多个可用的连接,以便能在它们之间切换

添加多个连接

根据要添加的其他连接,您必须首先完成以下任务之一:

  • 创建额外访问密钥(其中包含访问密钥 ID值和私有访问密钥值)或 AWS 账户根用户(我们强烈建议)中的用户(我们强烈劝阻)。如果您没有中用户 IAM 的访问密钥,请创建一个

  • Enabled (已启用)AWS SSO 访问,以获取其他用户的 AWS 账户。

注意

我们建议将敏感凭据信息(如包含访问密钥的命名配置文件)存储在credentials文件。不太敏感的配置选项(如使用 AWS SSO 进行身份验证的命名配置文件)通常存储在config文件。

您可以将所有命名配置文件存储在一个文件中。如果您使用的是credentialsconfig文件,credentials在 IDE 中默认打开。

如果两个文件中都有共享相同名称的配置文件的凭证,则credentials优先级。有关更多信息,请参阅 。配置和凭证文件设置中的AWS 命令行界面用户指南

  1. 首次连接(如果您尚未执行此操作)。

  2. 要开始编辑凭证文件,请执行下列操作之一:

    • 在状态栏上,选择AWS 连接设置,然后选择所有凭证编辑 AWS 凭证文件

      
            选择从状态栏编辑 AWS 凭证
    • 打开 AWS Explorer(如果尚未打开),然后选择Show Options 菜单(设置图标)。选择AWS 连接设置所有凭证编辑 AWS 凭证文件

      
            选择从 AWS 资源管理器编辑 AWS 证书
  3. 在文件中,为每个附加连接添加一个命名的配置文件。配置文件名称只能包含大写字母 A通过Z,小写字母a通过z, 数字0通过9,连字符(-)和下划线字符(_)。配置文件名称的长度必须小于 64 个字符。

    Profile with access keys

    例如,对于名为 myuser 的命名配置文件,请使用以下格式。

    [myuser] aws_access_key_id = AKIAIOSFODNN7EXAMPLE aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
    注意

    适用于 JetBrains 的 AWS 工具包目前支持仅包含以下字符的命名配置文件:A-Za-z0-9,下划线 (_) 和连字符 (-)。

    当前,该工具包仅支持以下配置变量:

    • aws_access_key_id

    • aws_secret_access_key

    • aws_session_token

    • credential_process

    • mfa_serial

    • role_arn

    • source_profile

    有关更多信息,请参阅 。AWS CLI 配置变量中的AWS CLI 命令参考

    Profile with AWS SSO

    使用 AWS SSO,您可以通过添加定义如何使用单点登录验证特定账户的命名配置文件来启用多个连接。确保每个已命名的配置文件添加到credentials文件具有唯一的名称,并将特定于帐户的值分配给 SSO 密钥。如下例所示。

    ... Other file contents omitted for brevity ... [profile user2] sso_start_url = https://my-sso-portal.awsapps.com/start sso_region = us-east-1 sso_account_id = 123456789011 sso_role_name = readOnly region = us-west-2 ... Other file contents omitted for brevity ...

    有关 AWS SSO 键-值对的更多信息,请参阅defining named profiles for SSO

  4. 保存该文件,然后将其关闭。适用于 JetBrains 的 AWS 工具包将在AWS 连接设置菜单中的状态栏和AWS Explorer

现在,您已有多个连接,可以在它们之间切换(如果需要)。

在您连接后,可能需要切换以使用该账户中位于不同 AWS 区域中的 AWS 资源

在连接之间切换

  1. 添加多个连接(如果尚未执行此操作)。

  2. 请执行下列操作之一:

    • 在状态栏上,选择AWS 连接设置

    • 打开 AWS Explorer(如果尚未打开),然后选择AWS 连接设置

  3. 选择要用于新连接的命名配置文件。如果它未列出,请选择所有凭证,然后选择命名配置文件要使用的。

    切换当前连接

    AWS Toolkit for JetBrains连接。此连接现在在AWS 连接设置菜单中的状态栏和AWS Explorer

在您连接后,可能需要切换以使用该账户中位于不同 AWS 区域中的 AWS 资源

更改连接设置

  1. 请执行下列操作之一:

    • 在状态栏上,选择AWS 连接设置所有凭证编辑 AWS 凭证文件

      
            选择“Edit AWS Credential files (编辑 AWS 凭证文件)”命令
    • 打开 AWS Explorer(如果尚未打开),然后选择Show Options 菜单(设置图标)。然后选择 。AWS 连接设置所有凭证编辑 AWS 凭证文件

      
            选择“Edit AWS Credential files (编辑 AWS 凭证文件)”命令
  2. 对此文件进行更改,然后保存并关闭此文件。

删除连接

  1. 请执行下列操作之一:

    • 在状态栏上,选择AWS 连接设置所有凭证编辑 AWS 凭证文件

      
            选择“Edit AWS Credential files (编辑 AWS 凭证文件)”命令
    • 打开 AWS Explorer(如果尚未打开),然后选择Show Options 菜单(设置图标)。然后选择 。AWS 连接设置所有凭证编辑 AWS 凭证文件

      
            选择“Edit AWS Credential files (编辑 AWS 凭证文件)”命令
  2. 在文件中,完全删除命名配置文件(指定访问密钥或 AWS SSO 键值对)。

  3. 保存该文件,然后将其关闭。适用于 JetBrains 的 AWS 工具包将删除的连接从AWS 连接设置菜单中的状态栏和AWS Explorer

删除连接后,可能需要切换到其他连接或重新进行首次连接