配置通知与 AWS Chatbot 之间的集成 - 开发工具控制台

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

配置通知与 AWS Chatbot 之间的集成

AWS Chatbot 是一项 AWS 服务,该服务使 DevOps 和软件开发团队能够使用 Amazon Chime 聊天室、Slack 通道和 Microsoft Teams 通道来监控和响应 AWS Cloud 中的操作事件。您可以配置通知规则目标与 AWS Chatbot 之间的集成,以便有关事件的通知显示在您选择的 Amazon Chime 聊天室、Slack 通道和 Microsoft Teams 通道中。有关更多信息,请参阅 AWS Chatbot 文档

在配置与 AWS Chatbot 的集成之前,您必须配置通知规则和规则目标。有关更多信息,请参阅 设置创建通知规则:您还必须在 AWS Chatbot 中配置 Slack 通道、Microsoft Teams 通道或 Amazon Chime 聊天室。有关更多信息,请参阅这些服务的文档。

为 Slack 通道配置 AWS Chatbot 客户端

您可以创建使用 AWS Chatbot 客户端作为目标的通知规则。如果您为 Slack 通道创建客户端,则可以在工作流中直接使用此客户端作为创建通知规则的目标。这是设置在 Slack 通道中显示的通知的最简单方法。

创建与 Slack 结合使用的 AWS Chatbot 客户端作为目标

  1. 按照《AWS Chatbot 管理员指南》中的设置 AWS Chatbot 与 Slack 结合使用中的说明进行操作。执行此操作时,请考虑以下选项以实现与通知的最佳集成:

    • 创建 IAM 角色时,请考虑选择一个角色名称,以便轻松识别此角色的用途(例如 AWSCodeStarNotifications-Chatbot-Slack-Role)。这可以帮助您确定未来角色的用途。

    • SNS topics (SNS 主题) 中,您无需选择主题或 AWS 区域。选择 AWS Chatbot 客户端作为目标时,在通知规则创建过程中,将为 AWS Chatbot 客户端创建并配置具有所有必需权限的 Amazon SNS 主题。

  2. 完成客户端创建过程。然后,您可以在创建通知规则时选择此客户端作为目标。有关更多信息,请参阅创建通知规则

    注意

    在为您配置 Amazon SNS 主题后,请勿将其从 AWS Chatbot 客户端中删除。这样做将阻止向 Slack 发送通知。

为 Microsoft Teams 通道配置 AWS Chatbot 客户端

您可以创建使用 AWS Chatbot 客户端作为目标的通知规则。如果您为 Microsoft Teams 通道创建客户端,则可以在工作流中直接使用此客户端作为创建通知规则的目标。这是设置在 Microsoft Teams 通道中显示的通知的最简单方法。

创建与 Microsoft Teams 结合使用的 AWS Chatbot 客户端作为目标

  1. 按照《AWS Chatbot 管理员指南》中的设置 AWS Chatbot 与 Microsoft Teams 结合使用中的说明进行操作。执行此操作时,请考虑以下选项以实现与通知的最佳集成:

    • 创建 IAM 角色时,请考虑选择一个角色名称,以便轻松识别此角色的用途(例如 AWSCodeStarNotifications-Chatbot-Microsoft-Teams-Role)。这可以帮助您确定未来角色的用途。

    • SNS topics (SNS 主题) 中,您无需选择主题或 AWS 区域。选择 AWS Chatbot 客户端作为目标时,在通知规则创建过程中,将为 AWS Chatbot 客户端创建并配置具有所有必需权限的 Amazon SNS 主题。

  2. 完成客户端创建过程。然后,您可以在创建通知规则时选择此客户端作为目标。有关更多信息,请参阅创建通知规则

    注意

    在为您配置 Amazon SNS 主题后,请勿将其从 AWS Chatbot 客户端中删除。这样做将阻止向 Microsoft Teams 发送通知。

为 Slack 或 Amazon Chime 手动配置客户端

您可以选择在通知和 Slack 或 Amazon Chime 之间直接创建集成。这是可用于配置 Amazon Chime 聊天室通知的唯一方法。手动配置此集成时,您将创建一个 AWS Chatbot 客户端,该客户端使用之前配置作为通知规则目标的 Amazon SNS 主题。

手动将通知与 AWS Chatbot 和 Slack 集成

  1. 打开 https://console.aws.amazon.com/codesuite/settings/notifications 上的 AWS 开发工具控制台。

  2. 选择 Settings (设置),然后选择 Notification rules (通知规则)

  3. Notification rule targets (通知规则目标) 中,查找并复制目标。

    注意

    您可以配置多个通知规则,以将同一 Amazon SNS 主题用作其目标。这可以帮助您整合消息传递,但如果订阅列表旨在用于一个通知规则或资源,则可能产生意想不到的后果。

  4. 打开 https://console.aws.amazon.com/chatbot/ 上的 AWS Chatbot 控制台。

  5. 选择 Configure new client (配置新客户端),然后选择 Slack

  6. 选择 Configure(配置)。

  7. 登录您的 Slack 工作区。

  8. 当系统提示您确认选择时,请选择 Allow (允许)

  9. 选择 Configure new channel (配置新通道)

  10. Configuration details (配置详细信息)Configuration name (配置名称) 中,输入客户端的名称。这是在您创建通知规则时,将显示在对 AWS Chatbot (Slack) 目标类型可用的目标列表中的名称。

  11. Configure Slack Channel(配置 Slack 通道)的 Channel type(通道类型)中,根据要集成的通道类型选择 Public(公有)或 Private(私有)。

    • Public channel (公有通道) 中,从列表中选择 Slack 通道的名称。

    • Private channel ID (私有通道 ID) 中,输入通道代码或 URL。

  12. IAM permissions (IAM 权限)Role (角色) 中,选择 Create an IAM role using a template (使用模板创建 IAM 角色)。在 Policy templates (策略模板) 中,选择 Notification permissions (通知权限)。在 Role name (角色名称) 中,输入此角色的名称(例如 AWSCodeStarNotifications-Chatbot-Slack-Role)。在 Policy templates (策略模板) 中,选择 Notification permissions (通知权限)

  13. SNS topics(SNS 主题)的 SNS Region(SNS 区域)中,选择您在其中创建通知规则目标的 AWS 区域。在 SNS topics (SNS 主题) 中,选择您配置为通知规则目标的 Amazon SNS 主题的名称。

    注意

    如果您将创建使用此客户端作为目标的通知规则,则无需执行此步骤。

  14. 选择 Configure(配置)。

    注意

    如果您配置了与私有通道的集成,则必须先将 AWS Chatbot 邀请到通道,然后才能在该通道中看到通知。有关更多信息,请参阅 AWS Chatbot 文档

  15. (可选)要测试集成,请在与通知规则(配置为使用 Amazon SNS 主题作为其目标)的事件类型匹配的资源中进行更改。例如,如果将通知规则配置为在对拉取请求进行注释时发送通知,请对拉取请求进行注释,然后在浏览器中观看 Slack 通道以查看通知何时出现。

将通知与 AWS Chatbot 和 Amazon Chime 集成

  1. 打开 https://console.aws.amazon.com/codesuite/settings/notifications 上的 AWS 开发工具控制台。

  2. 选择 Settings (设置),然后选择 Notification rules (通知规则)

  3. Notification rule targets (通知规则目标) 中,查找并复制目标。

    注意

    您可以配置多个通知规则,以将同一 Amazon SNS 主题用作其目标。这可以帮助您整合消息传递,但如果订阅列表旨在用于一个通知规则或资源,则可能产生意想不到的后果。

  4. 在 Amazon Chime 中,打开要配置以进行集成的聊天室。

  5. 选择右上角的齿轮图标,然后选择 Manage webhooks (管理 Webhook)

  6. Manage webhooks (管理 Webhook) 对话框中,选择 New (新建),输入 Webhook 的名称,然后选择 Create (创建)

  7. 确认 Webhook 已出现,然后选择 Copy webhook URL (复制 Webhook URL)

  8. 打开 https://console.aws.amazon.com/chatbot/ 上的 AWS Chatbot 控制台。

  9. 选择 Configure new client (配置新客户端),然后选择 Amazon Chime

  10. Configuration details (配置详细信息)Configuration name (配置名称) 中,输入客户端的名称。

  11. Webhook URL 中,粘贴该 URL。在 Webhook description (Webhook 描述) 中,提供可选的描述。

  12. IAM permissions (IAM 权限)Role (角色) 中,选择 Create an IAM role using a template (使用模板创建 IAM 角色)。在 Policy templates (策略模板) 中,选择 Notification permissions (通知权限)。在 Role name (角色名称) 中,输入此角色的名称(例如 AWSCodeStarNotifications-Chatbot-Chime-Role)。

  13. SNS topics(SNS 主题)的 SNS Region(SNS 区域)中,选择您在其中创建通知规则目标的 AWS 区域。在 SNS topics (SNS 主题) 中,选择您配置为通知规则目标的 Amazon SNS 主题的名称。

  14. 选择 Configure(配置)。

  15. (可选)要测试集成,请在与通知规则(配置为使用 Amazon SNS 主题作为其目标)的事件类型匹配的资源中进行更改。例如,如果将通知规则配置为在对拉取请求进行注释时发送通知,请对拉取请求进行注释,然后观看 Amazon Chime 聊天室以查看通知何时出现。