建立通知規則 - AWS CodeDeploy

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

建立通知規則

您可以使用通知規則，在部署應用程式發生變更時通知使用者，例如部署成功和部署失敗。通知規則指定用於傳送通知的事件和 Amazon SNS 主題。如需詳細資訊，請參閱什麼是通知？

您可以使用主控台或 AWS CLI 建立的通知規則 AWS CodeDeploy。

建立通知規則 (主控台)

  1. 請登入 AWS Management Console 並開啟 CodeDeploy 主控台，網址為 https://console.aws.amazon.com/codedeploy/。

  2. 選擇 Application (應用程式)，然後選擇要新增通知的應用程式。

  3. 在應用程式頁面上，選擇 Notify (通知)，然後選擇 Create notification rule (建立通知規則)。您也可以移至應用程式的 Settings (設定) 頁面，然後選擇 Create notification rule (建立通知規則)。

  4. 在 Notification name (通知名稱) 中，輸入規則的名稱。

  5. 如果您只想要提供給 Amazon 的資訊 EventBridge 包含在通知中，請在 [詳細資料類型] 中選擇 [基本]。如果您想要包含提供給 Amazon 的資訊以 EventBridge 及可能由 CodeDeploy 或通知管理員提供的資訊，請選擇「完整」。

    如需詳細資訊，請參閱瞭解通知內容和安全性。

  6. 在 Events that trigger notifications (觸發通知的事件) 中，選取您要傳送通知的事件。

    類別 事件

    部署

    失敗

    Succeeded

    已開始

  7. 在 Targets (目標) 中，選擇 Create SNS topic (建立 SNS 主題)。

    注意

    當您建立主題時，會套用 CodeDeploy 允許將事件發佈至主題的原則。使用專門針對 CodeDeploy 通知建立的主題也有助於確保您只將使用者新增至您想要查看有關此部署應用程式之通知之該主題的訂閱清單。

    在 codestar-notifications- 字首之後，輸入主題的名稱，然後選擇 Submit (提交)。

    注意

    如果您要使用現有 Amazon SNS 主題而非建立新主題，請在 Targets (目標) 中選擇其 ARN。請確定主題具有適當的存取政策，而且訂閱者清單只包含允許查看部署應用程式相關資訊的使用者。如需詳細資訊，請參閱針對通知設定現有 Amazon SNS 主題和了解通知內容和安全性。

  8. 若要完成建立規則，請選擇 Submit (提交)。

  9. 您必須先訂閱使用者訂閱規則的 Amazon SNS 主題，才能收到通知。如需詳細資訊，請參閱訂閱使用者訂閱屬於目標的 Amazon SNS 主題。您也可以設定通知之間的整合，並 AWS Chatbot 將通知傳送到 Amazon Chime 聊天室或 Slack 頻道。如需詳細資訊，請參閱設定通知與之間的整合 AWS Chatbot。

建立通知規則 (AWS CLI)

  1. 在終端機或命令提示字元中，執行 create-notification rule 命令以產生 JSON 架構：

    aws codestar-notifications create-notification-rule --generate-cli-skeleton > rule.json

    您可以將檔案命名為任何您想要的名稱。在此範例中，檔案命名為 rule.json。

  2. 在純文字編輯器中開啟 JSON 檔案，然後對其進行編輯，以包含您要用於規則的資源、事件類型和 Amazon SNS 目標。下列範例會顯示 AWS 針對識別碼MyNotificationRule為 123 456789012 的帳戶MyDeploymentApplication中名為的應用程式命名的通知規則。MyNotificationTopic當部署成功時，會將通知與完整詳細資料類型一起傳送至名為 codestar-通知的 Amazon SNS 主題：

    {
    "Name": "MyNotificationRule",
    "EventTypeIds": [
        "codedeploy-application-deployment-succeeded"
    ],
    "Resource": "arn:aws:codebuild:us-east-2:123456789012:MyDeploymentApplication",
    "Targets": [
        {
            "TargetType": "SNS",
            "TargetAddress": "arn:aws:sns:us-east-2:123456789012:codestar-notifications-MyNotificationTopic"
        }
    ],
    "Status": "ENABLED",
    "DetailType": "FULL"
}

    儲存檔案。

  3. 在終端機或命令列中，再次執行 create-notification-rule 命令，使用您剛編輯的檔案建立通知規則：

    aws codestar-notifications create-notification-rule --cli-input-json  file://rule.json

  4. 如果成功，此命令會傳回通知規則的 ARN，如下所示：

    {
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}