AWS Toolkit for JetBrains 的关键任务 - AWS Toolkit for JetBrains

AWS Toolkit for JetBrains 的关键任务

按照以下简要说明操作,使用 AWS Toolkit for JetBrains 完成关键任务。

安装 AWS Toolkit for JetBrains

  1. 创建一个 AWS 账户(如果您还没有 AWS 账户)。

  2. 在账户中,在 AWS Identity and Access Management (IAM) 中创建管理员用户和组(如果尚未这样做)。

    注意

    建议您在账户中为要使用的 AWS Toolkit for JetBrains 创建或使用特定类型的用户和组,我们将管理员 称作 IAM 用户和组。虽然您可以在账户中为要使用的工具包创建常规 IAM 用户和组,但此方法可能不允许工具包拥有对该账户中所有 AWS 资源和 AWS 无服务器应用程序的完全访问权限。(我们支持但强烈反对AWS 账户根用户用于 AWS Toolkit for JetBrains)

  3. 为用户创建访问密钥(如果您尚未为用户创建访问密钥)。

    注意

    访问密钥同时包含访问密钥 ID 值和秘密访问密钥 值。稍后,AWS Toolkit for JetBrains 需要使用这两个值。请务必将它们存储在安全位置。如果您丢失了它们,则它们就永远消失并且无法进行检索。但是,您始终可以删除丢失的访问密钥,然后创建替换访问密钥。如果您曾经执行了此操作,则还需要更改工具包连接设置。我们支持但强烈反对为 AWS 账户根用户创建的访问密钥 以供 AWS Toolkit for JetBrains 使用。

  4. 确保 IntelliJ IDEA, PyCharm, WebStorm, or JetBrains Rider 2019.2 或更高版本已安装并运行。

  5. 打开 Settings (设置)/Preferences (首选项)

  6. 选择 Plugins (插件)

  7. Marketplace 选项卡上的 Search plugins in marketplace (在 Marketplace 中搜索插件) 中,开始输入 AWS Toolkit。当显示 AWS Toolkit by Amazon Web Services (Amazon Web Services 提供的 AWS Toolkit) 时,选择它。

    
        查找 AWS Toolkit
  8. 选择安装

    
        安装 AWS Toolkit for JetBrains
    注意

    要使用 AWS Toolkit for JetBrains 以将其可用功能用于 AWS CloudFormation、Lambda、AWS Serverless 和 Amazon ECS,您必须安装 1.8 版或更高版本的 AWS Toolkit。

  9. 在显示 Third-party Plugins Privacy Note (第三方插件隐私说明) 时,选择 Accept (接受)

  10. 选择 Restart IDE (重新启动 IDE)

  11. 在系统提示时,选择 Restart (重新启动)

  12. 此外,必须先安装以下工具(如果尚未安装),然后才能使用 AWS Toolkit for JetBrains 开发、测试、分析和部署 AWS 无服务器应用程序或 Lambda 函数。必须按以下顺序安装这些工具:

    1. AWS Command Line Interface (AWS CLI)

    2. Docker(在您开发、测试、分析或部署无服务器应用程序或函数时,Docker 必须始终运行)

    3. AWS 无服务器应用程序模型 命令行界面 (AWS SAM CLI)

  13. 此外,您必须先完成其他步骤,然后才能使用 AWS Toolkit for JetBrains 调试 Amazon ECS 集群中的代码。有关说明,请参阅先决条件

  14. 在安装 AWS Toolkit for JetBrains(如果您使用 AWS 无服务器应用程序、Lambda 函数或 Amazon ECS 集群,则您已按顺序安装上述其他所需工具)后,首次连接到 AWS 账户

页首

更新 AWS Toolkit for JetBrains

安装 AWS Toolkit for JetBrains 后,您可以随时检查工具包的更新并安装这些更新。为此,请在 IntelliJ IDEA, PyCharm, WebStorm, or JetBrains Rider 已运行的情况下,执行以下操作。

  1. 打开 Settings (设置)/Preferences (首选项)

  2. 选择 Updates (更新)。(如果未显示任何更新,您可能需要选择 Check new updates (检查新更新)。)

    
        检查 AWS Toolkit for JetBrains 的更新
  3. 按照任何屏幕上说明执行操作,完成对 AWS Toolkit for JetBrains 的更新。

  4. 重启 IntelliJ IDEA, PyCharm, WebStorm, or JetBrains Rider.

配置 AWS Toolkit for JetBrains 以使用 HTTP 代理

安装 AWS Toolkit for JetBrains 后,您可以配置它以使用 HTTP 代理。在 IntelliJ IDEA, PyCharm, WebStorm, or JetBrains Rider 已运行的情况下,执行下列操作之一:

  • 对于 IntelliJ IDEA,请参阅 IntelliJ IDEA 帮助网站上的 HTTP 代理

  • 对于 PyCharm,请参阅 PyCharm 帮助网站上的 HTTP 代理

  • 对于 WebStorm,请参阅 WebStorm 帮助网站上的 HTTP 代理

  • 对于 JetBrains Rider,请参阅 JetBrains Rider 帮助网站上的配置 HTTP 代理

按照上述说明完成操作后,工具包将开始使用这些 HTTP 代理设置。

页首

将 AWS Toolkit for JetBrains 连接到 AWS 账户

安装 AWS Toolkit for JetBrains 后,使用工具包对 AWS 账户执行以下操作:

页首

首次连接到 AWS 账户

我们假设您已安装 AWS Toolkit for JetBrains。要完成此过程,您需要 IAM 中用户(推荐)或 AWS 账户根用户(强烈阻止)的 访问密钥(其中包含访问密钥 ID 值和秘密访问密钥 值)。(如果您没有 IAM 中用户的访问密钥,请创建一个。)

  1. 在准备好访问密钥 ID 值和秘密访问密钥值后,请执行下列操作之一:

    • 在状态栏上,选择 AWS: No credentials selected (AWS: 未选择凭证),然后选择 Edit AWS Credential file(s) (编辑 AWS 凭证文件)

      
            状态栏上的“AWS: no credentials selected (AWS: 未选择凭证)”
      
            从状态栏编辑 AWS 凭证
    • 打开 AWS Explorer(如果尚未打开)。选择 Configure AWS Connection (配置 AWS 连接),然后选择 Edit AWS Credential file(s) (编辑 AWS 凭证文件)

      
            从 AWS Explorer 配置 AWS 连接
      
            从 AWS Explorer 编辑 AWS 凭证
  2. 在文件中的 [default] 下,对于 aws_access_key_id,将 [accessKey1] 替换为访问密钥 ID 值(例如 AKIAIOSFODNN7EXAMPLE)。

    如果出现提示,请选择 I want to edit this file anyway (我仍要编辑此文件),然后选择 OK (确定)

  3. 对于 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 ...
    注意

    AWS Toolkit for JetBrains 当前支持以下配置变量:

    • aws_access_key_id

    • aws_secret_access_key

    • aws_session_token

    • credential_process

    • mfa_serial

    • role_arn

    • source_profile

    有关更多信息,请参阅 AWS CLI Command Reference 中的 AWS CLI 配置变量

  4. 保存该文件,然后将其关闭。AWS Toolkit for JetBrains 尝试使用前面的访问密钥连接到账户。

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

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

在您连接后,AWS Toolkit for JetBrains 会自动选择默认 AWS 区域。您可能需要切换连接以使用不同的 AWS 资源

页首

添加多个连接

要完成此过程,您必须先具有 IAM 中用户(推荐)或 AWS 账户根用户(强烈反对)的 访问密钥(同时包含访问密钥 ID 值和秘密访问密钥 值)。如果您没有 IAM 中用户的访问密钥,请创建一个

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

  2. 在准备好其他访问密钥 ID 值和秘密访问密钥值后,请执行下列操作之一:

    • 在状态栏上,选择 AWS Connection Settings (AWS 连接设置),然后选择 All Credentials (所有凭证)Edit AWS Credential file(s) (编辑 AWS 凭证文件)

      
            选择从状态栏编辑 AWS 凭证
    • 打开 AWS Explorer(如果它尚未打开),然后选择 Show Options Menu (显示选项菜单)(齿轮图标)。选择 AWS Connection Settings (AWS 连接设置)All Credentials (所有凭证)Edit AWS Credential file(s) (编辑 AWS 凭证文件)

      
            选择从 AWS Explorer 编辑 AWS 凭证
  3. 在文件中,为每个附加连接添加一个命名的配置文件。配置文件名称只能包含大写字母 AZ、小写字母 az、数字 09、连字符 (-) 以及下划线字符 (_)。配置文件名称的长度必须小于 64 个字符。

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

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

    AWS Toolkit for JetBrains 当前支持仅包含以下字符的命名配置文件: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 Command Reference 中的 AWS CLI 配置变量

  4. 保存该文件,然后将其关闭。AWS Toolkit for JetBrains 在状态栏和 AWS Explorer 中的 AWS Connection Settings (AWS 连接设置) 菜单中显示新连接。

现在,您已有多个连接,可以在它们之间切换

在您连接后,可能需要切换连接以进行使用

页首

在连接之间切换

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

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

    • 在状态栏上,选择 AWS Connection Settings (AWS 连接设置)

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

  3. 选择要用于新连接的命名配置文件。如果该配置文件未列出,请先选择 All Credentials (所有凭证),然后选择要使用的 named profile (命名配置文件)

    切换当前连接

    AWS Toolkit for JetBrains 切换为使用新连接。现已在状态栏和 AWS Explorer 中的 AWS Connection Settings (AWS 连接设置) 菜单中选择此连接。

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

页首

更改连接设置

  1. 执行以下任一操作:

    • 在状态栏上,依次选择 AWS Connection Settings (AWS 连接设置)All Credentials (所有凭证)Edit AWS Credential file(s) (编辑 AWS 凭证文件)

      
            选择“Edit AWS Credential files (编辑 AWS 凭证文件)”命令
    • 打开 AWS Explorer(如果它尚未打开),然后选择 Show Options Menu (显示选项菜单)(齿轮图标)。然后依次选择 AWS Connection Settings (AWS 连接设置)All Credentials (所有凭证)Edit AWS Credential file(s) (编辑 AWS 凭证文件)

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

页首

删除连接

  1. 执行以下任一操作:

    • 在状态栏上,依次选择 AWS Connection Settings (AWS 连接设置)All Credentials (所有凭证)Edit AWS Credential file(s) (编辑 AWS 凭证文件)

      
            选择“Edit AWS Credential files (编辑 AWS 凭证文件)”命令
    • 打开 AWS Explorer(如果它尚未打开),然后选择 Show Options Menu (显示选项菜单)(齿轮图标)。然后依次选择 AWS Connection Settings (AWS 连接设置)All Credentials (所有凭证)Edit AWS Credential file(s) (编辑 AWS 凭证文件)

      
            选择“Edit AWS Credential files (编辑 AWS 凭证文件)”命令
  2. 在文件中,完全删除要删除的连接的命名配置文件(包括命名配置文件的名称、访问密钥 ID 和秘密访问密钥)。

  3. 保存该文件,然后将其关闭。AWS Toolkit for JetBrains 从状态栏和 AWS Explorer 中的 AWS Connection Settings (AWS 连接设置) 菜单中移除已删除的连接。

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

页首

获取当前连接

要检查 AWS Toolkit for JetBrains 当前使用的连接,请执行下列操作之一:

  • 在状态栏上,查看 AWS Connection Settings (AWS 连接设置) 区域中显示的当前连接。

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

    
        AWS Explorer 中的当前连接

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

页首

获取当前正在使用的 AWS 区域

要检查 AWS Toolkit for JetBrains 当前正在使用的 AWS 区域,请执行下列操作之一:

  • 在状态栏上,查看 AWS Connection Settings (AWS 连接设置) 区域中显示的当前区域。

    
        状态栏中的当前 AWS 区域
  • 打开 AWS Explorer(如果它尚未打开),然后选择 Show Options Menu (显示选项菜单)(齿轮图标)。选择 AWS Connection Settings (AWS 连接设置)。当前区域已选定。

    
        AWS Explorer 中的当前 AWS 区域

您也可以切换到其他 AWS 区域

页首

在 AWS 区域之间切换

要切换 AWS 区域,请执行下列操作之一:

  • 在状态栏上,选择 AWS Connection Settings (AWS 连接设置),然后选择要切换到的 AWS 区域。

    在状态栏中选择不同的 AWS 区域
  • 打开 AWS Explorer(如果尚未打开)。选择 Show Options Menu (显示选项菜单)(齿轮菜单),然后选择 AWS Connection Settings (AWS 连接设置)。如果列出了要切换到的 AWS 区域,请选择此区域。否则,请选择 All Regions (所有区域),然后选择要切换到的区域。

    
        在 AWS Explorer 中选择其他 AWS 区域

AWS Toolkit for JetBrains 切换为使用新区域。现已在状态栏和 AWS Explorer 中的 AWS Connection Settings (AWS 连接设置) 菜单中选择区域。

页首

在 AWS Toolkit for JetBrains 中打开 AWS Explorer

要完成此过程,您必须先安装 AWS Toolkit。然后,在 IntelliJ IDEA, PyCharm, WebStorm, or JetBrains Rider 已运行的情况下,执行下列操作之一:

  • 在工具窗口栏上,选择 AWS Explorer

    
            AWS Explorer 工具窗口按钮
  • View (视图) 菜单上,选择 Tool Windows (工具窗口)AWS Explorer

    
            从主菜单中打开 AWS Explorer

在首次打开 AWS Explorer 后,使用它首次连接到 AWS 账户。在首次连接后,可以通过 AWS Explorer 使用账户中的 AWS Lambda 函数和 AWS CloudFormation 堆栈。

页首

使用 AWS 无服务器应用程序

安装 AWS Toolkit for JetBrains 并使用此工具包首次连接到 AWS 账户后,可以通过此工具包来使用账户中的 AWS 无服务器应用程序,如下所示:

页首

创建无服务器应用程序

要完成此过程,您必须先安装 AWS Toolkit for JetBrains,如果您尚未这样做,请首次连接到 AWS 账户。在 IntelliJ IDEA, PyCharm, WebStorm, or JetBrains Rider 已运行的情况下,请执行以下操作:

  1. 执行以下任一操作:

    • 对于 IntelliJ IDEA 或 WebStorm,依次选择 File (文件)New (新建)Project (项目)

    • 对于 PyCharm,依次选择 File (文件)New Project (新建项目)

    • 对于 JetBrains Rider,为新解决方案选择 File (文件)New (新建)。或者,右键单击 Explorer 工具窗口中的现有解决方案,然后选择 Add (添加)New Project (新建项目)

  2. 对于 IntelliJ IDEA,选择 AWSAWS Serverless Application (AWS 无服务器应用程序),然后选择 Next (下一步)

    选择在 IntelliJ IDEA 中创建 AWS 无服务器应用程序

    对于 PyCharm,选择 AWS Serverless Application (AWS 无服务器应用程序)

    选择在 PyCharm 中创建 AWS 无服务器应用程序

    对于 WebStorm,选择 AWS Serverless Application (AWS 无服务器应用程序)

    选择在 WebStorm 中创建 AWS 无服务器应用程序

    对于 JetBrains Rider,选择 AWS Serverless Application (AWS 无服务器应用程序)

    
        选择在 JetBrains Rider 中创建 AWS 无服务器应用程序
  3. 完成“New Project (新建项目)”对话框(或“New Solution (新建解决方案)”对话框 - 对于 JetBrains Rider)中的操作,然后选择 Finish (完成)(对于 IntelliJ IDEA)或 Create (创建)(对于 PyCharm、WebStorm 或 JetBrains Rider)。AWS Toolkit for JetBrains 会创建项目并将无服务器应用程序的代码文件添加到新项目中。

  4. 如果使用的是 IntelliJ IDEA,则在 Project (项目) 工具窗口已打开并显示包含无服务器应用程序文件的项目的情况下,请执行下列操作之一:

    • 对于基于 Maven 的项目,右键单击项目的 pom.xml 文件,然后选择 Add as Maven Project (添加为 Maven 项目)

      选择将 POM 文件添加为 Maven 项目
    • 对于基于 Gradle 的项目,右键单击项目的 build.gradle 文件,然后选择 Import Gradle project (导入 Gradle 项目)

      选择导入 Gradle 项目

      完成 Import Module from Gradle (从 Gradle 导入模块) 对话框中的操作,然后选择 OK (确定)

创建无服务器应用程序后,您可以运行(调用)或调试 AWS Lambda 函数的本地版本(包含在该应用程序中)。

您还可以部署无服务器应用程序。部署该应用程序后,可以运行(调用)Lambda 函数的远程版本(包含在部署的应用程序中)。

页首

部署无服务器应用程序

必须先创建 AWS 无服务器应用程序,然后才能使用此过程部署 AWS 无服务器应用程序。然后,按照以下步骤执行操作。

注意

要部署包含 AWS Lambda 函数的无服务器应用程序,并将该函数与任何非默认或可选属性一起部署,您必须先在函数的相应 AWS 无服务器应用程序模型 (AWS SAM) 模板文件中(例如,在项目中名为 template.yaml 的文件中)设置这些属性。有关可用属性的列表,请参阅 GitHub 上的 awslabs/serverless-application-model 存储库中的 AWS::Serverless::Function

  1. 如果您需要切换到其他 AWS 区域以部署无服务器应用程序,请立即执行此操作。

  2. Project (项目) 工具窗口已打开并显示包含无服务器应用程序文件的项目的情况下,请右键单击项目的 template.yaml 文件。然后,选择 Deploy Serverless Application (部署无服务器应用程序)

    选择“Deploy Serverless Application (部署无服务器应用程序)”命令
  3. 完成 Deploy Serverless Application (部署无服务器应用程序) 对话框中的操作,然后选择 Deploy (部署)

    AWS Toolkit for JetBrains 创建相应的 AWS CloudFormation 堆栈以进行部署。它还将堆栈名称添加到 AWS Explorer 中的 CloudFormation 列表。如果部署失败,您可以通过查看堆栈的事件日志来尝试查明原因。

部署该应用程序后,可以运行(调用)AWS Lambda 函数的远程版本(包含在部署的应用程序中)。

页首

更改(更新)无服务器应用程序的设置

必须先部署要更改的 AWS 无服务器应用程序,然后才能使用此过程更改无服务器应用程序的设置。然后,按照以下步骤执行操作。

注意

要部署包含 AWS Lambda 函数的无服务器应用程序,并将该函数与任何非默认或可选属性一起部署,您必须先在函数的相应 AWS SAM 模板文件中(例如,在项目中名为 template.yaml 的文件中)设置这些属性。有关可用属性的列表,请参阅 GitHub 上的 awslabs/serverless-application-model 存储库中的 AWS::Serverless::Function

  1. Project (项目) 工具窗口已打开并显示包含无服务器应用程序文件的项目的情况下,请打开项目的 template.yaml 文件。更改文件的内容以反映新设置,然后保存并关闭文件。

  2. 如果您需要切换到其他 AWS 区域(无服务器应用程序将部署到该区域),请立即执行此操作。

  3. 右键单击项目的 template.yaml 文件,然后选择 Deploy Serverless Application (部署无服务器应用程序)

    选择“Deploy Serverless Application (部署无服务器应用程序)”命令
  4. 完成 Deploy Serverless Application (部署无服务器应用程序) 对话框中的操作,然后选择 Deploy (部署)。AWS Toolkit for JetBrains 更新部署的相应 AWS CloudFormation 堆栈。

    如果部署失败,您可以通过查看堆栈的事件日志来尝试查明原因。

页首

删除无服务器应用程序

必须先部署要删除的 AWS 无服务器应用程序,然后才能使用此过程删除无服务器应用程序。然后,按照以下步骤执行操作。

  1. 打开 AWS Explorer(如果尚未打开)。如果您需要切换到其他 AWS 区域(该区域包含无服务器应用程序),请立即执行此操作。

  2. 展开 CloudFormation

  3. 右键单击 AWS CloudFormation 堆栈(包含要删除的无服务器应用程序)的名称,然后选择 Delete CloudFormation Stack (删除 CloudFormation 堆栈)

    
        选择删除从 AWS Explorer 启动的 AWS 无服务器应用程序的 AWS CloudFormation 堆栈
  4. 输入堆栈的名称来确认删除,然后选择 OK (确定)。如果堆栈删除成功,AWS Toolkit for JetBrains 将从 AWS Explorer 中的 CloudFormation 列表中删除堆栈名称。如果堆栈删除失败,您可以通过查看堆栈的事件日志来尝试查明原因。

页首

使用 AWS Lambda 函数

安装 AWS Toolkit for JetBrains 并使用此工具包首次连接到 AWS 账户后,可以通过此工具包来使用账户中的 Lambda 函数,如下所示。

页首

创建函数

可以使用 AWS Toolkit for JetBrains 创建 Lambda 函数(它是 AWS 无服务器应用程序的一部分),也可以单独创建 Lambda 函数。

创建包含 Lambda 函数的无服务器应用程序

请参阅本主题前面的有关创建 AWS 无服务器应用程序的说明。

页首

创建独立函数

要完成此过程,您必须先安装 AWS Toolkit for JetBrains,如果您尚未这样做,请首次连接到 AWS 账户。然后,在 IntelliJ IDEA, PyCharm, WebStorm, or JetBrains Rider 已运行的情况下,执行下列操作之一:

  • 打开 AWS Explorer(如果尚未打开)。如果您需要切换到其他 AWS 区域(将在该区域中创建函数),请立即执行此操作。然后,右键单击 Lambda,并选择 Create new AWS Lambda (创建新的 AWS Lambda)

    
        通过从 AWS Explorer 启动来创建 AWS Lambda 函数

    完成 Create Function (创建函数) 对话框中的操作,然后选择 Create Function (创建函数)。AWS Toolkit for JetBrains 创建相应的 AWS CloudFormation 堆栈以进行部署,并在 AWS Explorer 中将函数名称添加到 Lambda 列表。如果部署失败,您可以通过查看堆栈的事件日志来尝试查明原因。

  • 创建一个代码文件,该文件实施 JavaPythonNode.jsC# 的函数处理程序。

    要允许运行(调用)函数的远程版本(如果您需要切换到其他 AWS 区域(将在该区域中创建函数)),请立即执行此操作。然后在代码文件中,选择函数处理程序旁边的边沟中的 Lambda 图标,并选择 Create new AWS Lambda (创建新的 AWS Lambda).完成 Create Function (创建函数) 对话框中的操作,然后选择 Create Function (创建函数)

    
        通过从代码文件中的现有函数处理程序启动来创建 AWS Lambda 函数
    注意

    如果 Lambda 图标未显示在函数处理程序旁边的边沟中,您可以通过选中 Settings (设置)/Preferences (首选项) 中的以下框来为当前项目显示该图标:Tools (工具)AWSProject settings (项目设置)Show gutter icons for all potential AWS Lambda handlers (显示所有潜在 AWS Lambda 处理程序的边沟图标)。此外,如果已在相应的 AWS SAM 模板中定义函数处理程序,则不会显示 Create new AWS Lambda (创建新的 AWS Lambda) 命令。

    在选择 Create Function (创建函数) 后,AWS Toolkit for JetBrains 会在 Lambda 服务中为连接的 AWS 账户创建相应的函数。如果操作成功,则在您刷新 AWS Explorer 后,Lambda 列表会显示新函数的名称。

  • 如果您已有一个包含 AWS Lambda 函数的项目,并且您需要先切换到其他 AWS 区域(将在该区域中创建函数),请立即执行此操作。然后,在包含 JavaPythonNode.jsC# 的函数处理程序的代码文件中,选择函数处理程序旁边的边沟中的 Lambda 图标。选择 Create new AWS Lambda (创建新的 AWS Lambda),完成 Create Function (创建函数) 对话框中的操作,然后选择 Create Function (创建函数)

    
        通过从代码文件中的现有函数处理程序启动来创建 AWS Lambda 函数
    注意

    如果 Lambda 图标未显示在函数处理程序旁边的边沟中,您可以通过选中 Settings (设置)/Preferences (首选项) 中的以下框来为当前项目显示该图标:Tools (工具)AWSProject settings (项目设置)Show gutter icons for all potential AWS Lambda handlers (显示所有潜在 AWS Lambda 处理程序的边沟图标)。此外,如果已在相应的 AWS SAM 模板中定义函数处理程序,则不会显示 Create new AWS Lambda (创建新的 AWS Lambda) 命令。

    在选择 Create Function (创建函数) 后,AWS Toolkit for JetBrains 会在 Lambda 服务中为连接的 AWS 账户创建相应的函数。如果操作成功,则在刷新 AWS Explorer 后,新函数的名称将显示在 Lambda 列表中。

创建函数后,您可以运行(调用)或调试函数的本地版本运行(调用)远程版本

页首

运行(调用)或调试函数的本地版本

AWS Lambda 函数的本地 版本是其源代码已存在于本地开发计算机上的函数。

要完成此过程,必须先创建 AWS Lambda 函数(如果尚未创建它)以运行(调用)或进行调试。

注意

如果要运行(调用)或调试 AWS Lambda 函数的本地版本,并使用任何非默认或可选属性本地运行(调用)或调试该函数,则必须先在函数的相应 AWS SAM 模板文件中(例如,在项目中名为 template.yaml 的文件中)设置这些属性。有关可用属性的列表,请参阅 GitHub 上的 awslabs/serverless-application-model 存储库中的 AWS::Serverless::Function

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

    • 在包含 JavaPythonNode.jsC# 的函数处理程序的代码文件中,选择函数处理程序旁边的边沟中的 Lambda 图标。选择 Run '[Local]' (运行“[本地]”)Debug '[Local]' (调试“[本地]”)

      
            通过从代码文件中的函数处理程序启动来运行或调试 Lambda 函数的本地版本
    • Project (项目) 工具窗口已打开并显示包含函数的项目后,打开项目的 template.yaml 文件。选择函数的资源定义旁边的边沟中的 Run (运行) 图标,然后选择 Run '[Local]' (运行“[本地]”)Debug '[Local]' (调试“[本地]”)

      
            通过从 AWS SAM 模板文件中的函数定义开始来运行或调试 Lambda 函数的本地版本
  2. Edit configuration (编辑配置) 对话框(如果已显示)中编辑完配置后,选择 Run (运行)Debug (调试)。(如果 Edit configuration (编辑配置) 对话框未出现,并且您要更改现有配置,请先更改其配置,然后从头开始重复此过程。)如果缺少配置详细信息,请展开 Templates (模板)AWS Lambda,然后选择 Local (本地)。选择 OK (确定),然后从头开始重复此过程。 结果将显示在 Run (运行)Debug (调试) 工具窗口中。

页首

运行(调用)函数的远程版本

AWS Lambda 函数的远程 版本是其源代码已存在于 AWS 账户的 Lambda 服务内的函数。

要完成此过程,您必须先安装 AWS Toolkit for JetBrains,如果您尚未这样做,请首次连接到 AWS 账户。然后,在 IntelliJ IDEA, PyCharm, WebStorm, or JetBrains Rider 已运行的情况下,执行以下操作。

  1. 打开 AWS Explorer(如果尚未打开)。如果您需要切换到其他 AWS 区域(该区域包含函数),请立即执行此操作。

  2. 展开 Lambda,并确认已列出函数的名称。如果已列出函数名称,则跳到本过程的步骤 3。

    如果未列出函数的名称,请创建要运行(调用)的 Lambda 函数(如果您尚未执行此操作)。

    如果已创建函数作为 AWS 无服务器应用程序的一部分,则还必须部署该应用程序

    如果已通过创建一个实施 JavaPythonNode.jsC# 的函数处理程序的代码文件来创建函数,则在代码文件中,选择函数处理程序旁边的 Lambda 图标。然后选择 Create new AWS Lambda (创建新的 AWS Lambda)。完成 Create Function (创建函数) 对话框中的操作,然后选择 Create Function (创建函数)

  3. AWS Explorer 中展开 Lambda 后,右键单击函数名称,然后选择 Run '[Remote]' (运行“[远程]”)

    
        通过从 AWS Explorer 启动来运行 Lambda 函数的远程版本
  4. Edit configuration (编辑配置) 对话框(如果已显示)中编辑完配置后,选择 Run (运行)。(如果 Edit configuration (编辑配置) 对话框未出现,并且您要更改现有配置,请先更改其配置,然后从步骤 3 开始重复此过程。如果缺少配置详细信息,请展开 Templates (模板)AWS Lambda。选择 Remote (远程),再选择 OK (确定),然后从头开始重复此过程。) 结果将显示在 Run (运行) 工具窗口中。

页首

更改(更新)函数的配置

请执行下列操作之一:

  • 在包含适用于 JavaPythonNode.jsC# 的函数处理程序的代码文件打开后,在主菜单上,选择 Run (运行)Edit Configurations (编辑配置)。在 Run/Debug Configurations (运行/调试配置) 对话框中完成相应的操作,然后选择 OK (确定)

  • 打开 AWS Explorer(如果尚未打开)。如果您需要切换到其他 AWS 区域(该区域包含函数),请立即执行此操作。展开 Lambda,选择要更改其配置的函数的名称,然后执行下列操作之一:

    • 更改设置,例如超时、内存、环境变量和执行角色 – 右键单击函数的名称,然后选择 Update Function Configuration (更新函数配置)

      选择“Update Function Configuration (更新函数配置)”命令

      完成 Update Configuration (更新配置) 对话框中的操作,然后选择 Update (更新)

    • 更改设置,例如输入负载 – 在主菜单上,选择 Run (运行)Edit Configurations (编辑配置)。在 Run/Debug Configurations (运行/调试配置) 对话框中完成相应的操作,然后选择 OK (确定)

      选择“Edit Configurations (编辑配置)”命令

      如果缺少配置详细信息,请先展开 Templates (模板)AWS Lambda,然后选择 Local (本地)(对于函数的本地版本)或 Remote (远程)(对于同一函数的远程版本)。选择 OK (确定),然后从头开始重复此过程。

    • 更改设置,例如函数处理程序名称或 Amazon Simple Storage Service (Amazon S3) 源存储桶 – 右键单击函数名称,然后选择 Update Function Code (更新函数代码)

      选择“Update Function Code (更新函数代码)”命令

      完成 Update Code (更新代码) 对话框中的操作,然后选择 Update (更新)

    • 更改上一个项目符号列表中未列出的其他可用属性设置 – 更改函数的相应 AWS SAM 模板文件(例如,在项目中名为 template.yaml 的文件中)中的这些设置。

      有关可用属性设置的列表,请参阅 GitHub 上的 awslabs/serverless-application-model 存储库中的 AWS::Serverless::Function

页首

删除函数

可以使用 AWS Toolkit for JetBrains 删除 AWS Lambda 函数(它是 AWS 无服务器应用程序的一部分)。也可以删除独立的 Lambda 函数

删除包含函数的无服务器应用程序

请参阅本主题前面的有关删除无服务器应用程序的说明。

页首

删除独立函数

  1. 打开 AWS Explorer(如果尚未打开)。如果您需要切换到其他 AWS 区域(该区域包含函数),请立即执行此操作。

  2. 展开 Lambda

  3. 右键单击要删除的函数的名称,然后选择 Delete Function (删除函数)

    选择“Delete Function (删除函数)”命令
  4. 输入函数的名称来确认删除,然后选择 OK (确定)。如果函数删除成功,则 AWS Toolkit for JetBrains 会从 Lambda 列表中删除函数名称。

页首

使用 AWS CloudFormation 堆栈

安装 AWS Toolkit for JetBrains 并使用此工具包首次连接到 AWS 账户后,可以通过此工具包来使用账户中的 AWS CloudFormation 堆栈,如下所示。

目前,您不能使用 AWS Toolkit for JetBrains 直接创建堆栈更改堆栈设置。但是,您可以在使用 AWS 无服务器应用程序和 AWS Lambda 函数的过程中,间接执行这些任务,如下所示。

页首

创建堆栈

目前,您无法使用 AWS Toolkit for JetBrains 直接创建 AWS CloudFormation 堆栈。不过,当您使用 AWS Toolkit for JetBrains 部署 AWS 无服务器应用程序创建并部署 AWS Lambda 函数时,工具包会通过以下方式做到这一点:先在 AWS CloudFormation 中创建相应的堆栈,然后使用该堆栈进行部署。

页首

更改堆栈设置

目前,您无法使用 AWS Toolkit for JetBrains 直接更改 AWS CloudFormation 堆栈的设置。但是,您可以更改(更新)AWS 无服务器应用程序的设置(该应用程序属于堆栈)或更改(更新)AWS Lambda 函数的配置(该函数属于堆栈)。然后,您重新部署该无服务器应用程序或重新部署该函数(作为运行(调用)函数的远程版本 的生命周期的一部分)。

页首

查看堆栈的事件日志

  1. 打开 AWS Explorer(如果尚未打开)。如果堆栈位于与当前 AWS 区域不同的 AWS 区域,请切换到其他 AWS 区域(该区域包含此堆栈)。

  2. 展开 CloudFormation

  3. 要查看堆栈的事件日志,请右键单击堆栈的名称。AWS Toolkit for JetBrains 在 CloudFormation 工具窗口中显示事件日志。

    要隐藏或显示 CloudFormation 工具窗口,请在主菜单上,依次选择 View (查看)Tool Windows (工具窗口)CloudFormation

    
        选择查看从 AWS Explorer 启动的 AWS CloudFormation 堆栈的事件日志

页首

删除堆栈

  1. 打开 AWS Explorer(如果尚未打开)。如果您需要切换到其他 AWS 区域(该区域包含堆栈),请立即执行此操作。

  2. 展开 CloudFormation

  3. 右键单击要删除的堆栈的名称,然后选择 Delete CloudFormation Stack (删除 CloudFormation 堆栈)

    
        选择删除从 AWS Explorer 启动的 AWS CloudFormation 堆栈
  4. 输入堆栈的名称来确认其删除,然后选择 OK (确定)。如果堆栈删除成功,AWS Toolkit for JetBrains 将从 AWS Explorer 中的 CloudFormation 列表中删除堆栈名称。如果堆栈删除失败,您可以通过查看堆栈的事件日志来进行故障排除。

页首

使用 Amazon ECS 集群

安装 AWS Toolkit for JetBrains 并使用此工具包首次连接到 AWS 账户后,可以通过此工具包来使用账户中的 Amazon ECS 集群,如下所示。

调试集群中的代码

具备先决条件后,执行以下操作:

  1. 打开 AWS Explorer(如果尚未打开)。如果 Amazon ECS 集群位于与当前 AWS 区域不同的 AWS 区域,请切换到包含此集群的 AWS 区域

  2. 展开 ECS,然后展开 Clusters (集群)

  3. 展开 Amazon ECS 集群,右键单击服务,然后选择 Enable Cloud Debugging (启用云调试)。例如,在以下屏幕截图中,集群名为 java,服务名为 java-service

    
        在 AWS Explorer 中启用云调试
  4. 在出现提示时,选择您的 Amazon ECS 任务角色,然后选择 OK (确定)

  5. 状态栏显示消息 Configuring Cloud Debugging resource (配置云调试资源)。请等待,直至 Build (构建) 工具窗口的 Build Output (构建输出) 选项卡显示成功配置消息。(右下角也会显示相关弹出消息。) 这将需要花几分钟的时间。

    注意

    当您首次在 AWS 账户中启用代码调试时,AWS Toolkit for JetBrains 会在您的 AWS 账户中创建一个 Amazon S3 存储桶。此存储桶的名称遵循以下格式:do-not-delete-cloud-debug-Region-ID-account-ID。JetBrains Toolkit 将信息存储在此存储桶中以启用代码调试。请不要删除此存储桶或修改其内容。 如果您这样做的话,代码调试可能会停止工作或产生意外的结果。如果您意外删除或修改了此存储桶,则 JetBrains Toolkit 将尝试重新创建此存储桶。您还可以通过再次选择 Enable Cloud Debugging (启用云调试)(如前所述)或选择 Disable Cloud Debugging (禁用云调试)(如本过程稍后所述)来强制 JetBrains Toolkit 重新创建存储桶。

  6. 在显示了要调试的代码后,在 AWS Explorer 中,依次展开 ECSClusters (集群) 和您的集群。此时将显示服务,旁边有一个调试图标。这表示现已启用服务以进行云调试。右键单击带调试图标的服务,然后选择 Debug (调试)

    
        在 AWS Explorer 中调试 Amazon ECS 服务
  7. Edit configuration (编辑配置) 对话框中编辑完配置,然后选择 Debug (调试)

    注意

    要稍后更改此配置,请在菜单栏上,选择 Run (运行)Edit Configurations (编辑配置)。然后,展开 Amazon ECS Service Cloud Debug (Amazon ECS 服务云调试),然后选择服务的名称。

  8. 使用 IDE 的内置调试工具像往常一样调试代码。

  9. 如果您已更改代码,则可以重新开始调试:在 AWS Explorer 中,依次展开 ECSClusters (集群) 和您的集群。右键单击旁边带有调试图标的服务,然后选择 Debug (调试)

  10. 如果您更改关联的 Dockerfile,则必须重新构建并重新发布 Docker 映像,然后从头开始重复此过程。

  11. 要禁用调试,请在 AWS Explorer 中,依次展开 ECSClusters (集群) 和您的集群。右键单击旁边有调试图标的服务,然后选择 Disable Cloud Debugging (禁用云调试)。此时将显示一个弹出窗口,用于确认已禁用调试。

页首

使用 Amazon EventBridge 架构

请参阅使用 Amazon EventBridge 架构

页首

使用 Amazon S3 存储桶和对象

安装 AWS Toolkit for JetBrains 并使用此工具包首次连接到 AWS 账户后,可以通过此工具包来使用账户中的 Amazon S3 存储桶和对象,如下所示。

页首