建立通知規則 - AWS CodeCommit

AWS CodeCommit 不再提供給新客戶。的現有客戶 AWS CodeCommit 可繼續正常使用此服務。了解更多」

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

建立通知規則

您可以使用通知規則來通知使用者重要的變更，例如：在儲存庫中建立提取請求時。通知規則指定用於傳送通知的事件和 Amazon SNS 主題。如需詳細資訊，請參閱什麼是通知？

注意

歐洲 (米蘭) 地區不提供此功能。若要瞭解如何在該區域的可用體驗中設定通知，請參閱設定儲存庫通知。

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

建立通知規則 (主控台)

  1. 登入 AWS Management Console 並開啟 CodeCommit 主控台，位於https://console.aws.amazon.com/codecommit/。

  2. 選擇 Repositories (儲存庫)，然後選擇您要新增通知規則的儲存庫。

  3. 在儲存庫頁面中，選擇 Notify (通知)，然後選擇 Create notification rule (建立通知規則)。您也可以移至儲存庫的 Settings (設定) 頁面，然後選擇 Create notification rule (建立通知規則)。

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

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

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

  6. 在 Events that trigger notifications (觸發通知的事件) 中，選取您要傳送通知的事件。如需詳細資訊，請參閱儲存庫上通知規則的事件。

  7. 在 Targets (目標) 中，執行下列其中一個動作：

    • 如果您已設定要與通知搭配使用的資源，請在 [選擇目標類型] 中選擇 [AWS Chatbot (Slack)] 或 [SNS主題]。在選擇目標中，選擇用戶端的名稱 (針對在中設定的 Slack 用戶端 AWS Chatbot) 或 Amazon 資源名稱 (ARN) (適用於已設定通知所需政策的 Amazon SNS 主題)。SNS

    • 如果您尚未設定要與通知搭配使用的資源，請選擇 [建立目標]，然後選擇 [SNS主題]。在 codestar-notifications- 之後，提供主題名稱，然後選擇 Create (建立)。

    注意

    • 如果您在建立通知規則時建立 Amazon SNS 主題，則會套用允許通知功能將事件發佈到主題的政策。使用針對通知規則建立的主題，有助於確保您只訂閱需要接收此資源相關通知的使用者。

    • 您無法建立 AWS Chatbot 用戶端做為建立通知規則的一部分。如果您選擇 AWS Chatbot （Slack），您將看到一個按鈕，指示您在中 AWS Chatbot配置客戶端。選擇該選項會開啟主 AWS Chatbot 控台。如需詳細資訊，請參閱設定通知與之間的整合 AWS Chatbot。

    • 如果您想要使用現有的 Amazon SNS 主題作為目標，除了該主題可能存在的任何其他政策之外，還必須新增AWS CodeStar通知所需的政策。如需詳細資訊，請參閱為通知設定 Amazon SNS 主題和了解通知內容和安全性。

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

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

建立通知規則 (AWS CLI)

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

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

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

  2. 在純文字編輯器中開啟JSON檔案，然後對其進行編輯，以包含您要用於規則的資源、事件類型和目標。下列範例顯示為名為的存放庫命名MyNotificationRule的通知規則 MyDemoRepo 在具有 AWS ID 的帳戶中 123456789012。 具有完整詳細資料類型的通知會傳送至名為的 Amazon SNS 主題 MyNotificationTopic 創建分支和標籤時：

    {
    "Name": "MyNotificationRule",
    "EventTypeIds": [
        "codecommit-repository-branches-and-tags-created"
    ],
    "Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo",
    "Targets": [
        {
            "TargetType": "SNS",
            "TargetAddress": "arn:aws:sns:us-east-1:123456789012: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"
}