設定通知和 AWS Chatbot 之間的整合 - 開發人員工具主控台

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

設定通知和 AWS Chatbot 之間的整合

AWS Chatbot 是一項 AWS 服務,可讓 DevOps 和軟體開發團隊使用 Amazon Chime 聊天室、Slack 頻道和 Microsoft Team 頻道,並監控及回應 AWS 雲端 中的操作事件。您可以設定通知規則目標與 AWS Chatbot 之間的整合,讓事件相關通知顯示在您選擇的 Amazon Chime 聊天室、Slack 頻道和 Microsoft Team 頻道中。如需詳細資訊,請參閱 AWS Chatbot 文件

在設定與 AWS Chatbot 的整合之前,您必須先設定通知規則和規則目標。如需詳細資訊,請參閱設定建立通知規則。您也必須在 AWS Chatbot 中設定 Slack 頻道、Microsoft Teams 頻道或 Amazon Chime 聊天室。如需詳細資訊,請參閱這些服務的文件。

為 Slack 頻道設定 AWS Chatbot 用戶端

您可以建立使用 AWS Chatbot 用戶端做為目標的通知規則。如果您為 Slack 頻道建立用戶端,則可以直接使用此用戶端,做為建立通知規則之工作流程中的目標。這是設定出現在 Slack 頻道中的通知最簡單的方法。

使用 Slack 建立 AWS Chatbot 用戶端做為目標

  1. 請依照 AWS Chatbot 管理員指南中的在 Slack 中設定 AWS Chatbot 的指示操作。當您執行這項操作時,請考慮下列選項,以便與通知進行最佳整合:

    • 建立 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 Team 頻道建立用戶端,則可以直接使用此用戶端,做為建立通知規則之工作流程中的目標。這是設定出現在 Microsoft Teams 頻道中的通知最簡單的方法。

使用 Microsoft Teams 頻道建立 AWS Chatbot 用戶端做為目標

  1. 請依照《AWS Chatbot 管理員指南》中的在 Microsoft Teams 中設定 AWS Chatbot 的指示操作。當您執行這項操作時,請考慮下列選項,以便與通知進行最佳整合:

    • 建立 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 settings (通知設定)

  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 (使用範本建立 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 settings (通知設定)

  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 (使用範本建立 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 聊天室,查看通知何時出現。