创建通知规则 - AWS CodeBuild

创建通知规则

您可以使用通知规则在发生重要更改（例如，构建成功和失败）时通知用户。通知规则指定用于发送通知的事件和 Amazon SNS 主题。有关更多信息，请参阅什么是通知？

您可以使用控制台或 AWS CLI 为 AWS CodeBuild 创建通知规则。

创建通知规则（控制台）

  1. 登录 AWS 管理控制台 并打开 CodeBuild 控制台 (https://console.aws.amazon.com/codebuild/)。

  2. 选择构建，再选择构建项目，然后选择要在其中添加通知的构建项目。

  3. 在构建项目页面上，选择通知，然后选择创建通知规则。您也可以转到构建项目的设置页面，然后选择创建通知规则。

  4. 在通知名称中，输入规则的名称。

  5. 如果您只想在通知中包含提供给 Amazon EventBridge 的信息，则在详细信息类型中，选择基本。如果您希望包含提供给 Amazon EventBridge 的信息以及 CodeBuild 或通知管理器可能提供的信息，请选择完整。

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

  6. 在触发通知的事件中，选择要为其发送通知的事件。有关详细信息，请参阅构建项目的通知规则的事件。

  7. 在目标中，执行下列操作之一：

    • 如果您已将资源配置为与通知一起使用，请在选择目标类型中，选择聊天应用程序中的 Amazon Q 开发者版（Slack）或 SNS 主题。在选择目标中，选择客户端的名称（对于在聊天应用程序的 Amazon Q 开发者版中配置的 Slack 客户端）或 Amazon SNS 主题的 Amazon 资源名称（ARN）（对于已使用通知所需策略配置的 Amazon SNS 主题）。

    • 如果您尚未将资源配置为与通知一起使用，请选择创建目标，然后选择 SNS 主题。在 codestar-notifications- 之后提供主题的名称，然后选择创建。

    注意

    • 如果您在创建通知规则的过程中创建 Amazon SNS 主题，则为您应用允许通知功能将事件发布到主题的策略。使用为通知规则创建的主题有助于确保您仅订阅要接收有关此资源的通知的那些用户。

    • 您不能在创建通知规则的过程中在聊天应用程序中创建 Amazon Q 开发者版。如果您在聊天应用程序（Slack）中选择 Amazon Q 开发者版，您会看到一个按钮，引导您在聊天应用程序的 Amazon Q 开发者版中配置客户端。选择该选项后，会在聊天应用程序控制台中打开 Amazon Q 开发者版。有关更多信息，请参阅在聊天应用程序中配置通知与 Amazon Q 开发者版之间的集成。

    • 如果要使用现有 Amazon SNS 主题作为目标，则在该主题可能存在的任何其他策略之外，您还必须为 AWS CodeStar 通知添加所需的策略。有关更多信息，请参阅为通知配置 Amazon SNS 主题以及了解通知内容和安全性。

  8. 要完成规则创建，请选择提交。

  9. 您必须为用户订阅规则的 Amazon SNS 主题，然后他们才能接收通知。有关更多信息，请参阅为用户订阅作为目标的 Amazon SNS 主题。您还可以在聊天应用程序中设置通知与 Amazon Q 开发者版之间的集成，以将通知发送到 Amazon Chime 聊天室。有关更多信息，请参阅在聊天应用程序中配置通知与 Amazon Q 开发者版之间的集成。

创建通知规则（AWS CLI）

  1. 在终端或命令提示符处，运行 create-notification rule 命令以生成 JSON 骨架：

    aws codestarnotifications create-notification-rule --generate-cli-skeleton > rule.json

    您可以将此文件命名为所需的任意名称。在本示例中，文件命名为 rule.json。

  2. 在纯文本编辑器中打开 JSON 文件，然后对其进行编辑，以包括该规则所需的资源、事件类型和目标。以下示例显示了一个名为 MyNotificationRule 的通知规则，应用于 AWS 账户（ID 为 123456789012）中名为 MyBuildProject 的构建项目。构建成功后，系统会向名为 codestar-notifications-MyNotificationTopic 的 Amazon SNS 主题发送通知，并附上完整的详细信息类型：

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

    保存该文件。

  3. 通过使用您刚编辑的文件，在终端或命令行上，再次运行 create-notification-rule 命令以创建通知规则：

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

  4. 如果成功，该命令将返回通知规则的 ARN，类似于以下内容：

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