创建通知规则 - 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 的信息，则在 Detail type (详细信息类型) 中，选择 Basic (基本)。选择完整如果您要包括提供给 Amazon EventBridge 的信息以及 CodeDeploy 或通知管理器可能提供的信息。

    有关更多信息，请参阅 。了解通知内容和安全性.

  6. 在 Events that trigger notifications (触发通知的事件) 中，选择要为其发送通知的事件。

    类别 事件

    部署

    失败

    Succeeded

    Started

  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 目标。以下示例显示一个名为的通知规则：MyNotificationRule对于名为的应用程序MyDeploymentApplication 程序在AWS带有 ID 的账户123456789012. 将以完整详情类型发送通知到名为的 Amazon SNS 主题。Codestar-通知-我的通知主题当部署成功时：

    {
    "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"
}