AWS::CodeStarNotifications::NotificationRule - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::CodeStarNotifications::NotificationRule

为资源创建通知规则。该规则指定您要获得通知的事件以及要接收通知的目标(例如 Amazon SNS 主题或为 Slack 配置的 AWS Chatbot 客户端)。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::CodeStarNotifications::NotificationRule", "Properties" : { "DetailType" : String, "EventTypeIds" : [ String, ... ], "Name" : String, "Resource" : String, "Status" : String, "Tags" : Json, "Targets" : [ Target, ... ] } }

YAML

Type: AWS::CodeStarNotifications::NotificationRule Properties: DetailType: String EventTypeIds: - String Name: String Resource: String Status: String Tags: Json Targets: - Target

属性

DetailType

要在该资源的通知中包含的详细信息级别。BASIC 仅包含在 AWS CloudWatch 中显示的事件内容。FULL 将包含 AWS CodeStar Notifications 和/或服务为创建了通知的资源提供的任何补充信息。

必需:是

类型:字符串

允许的值BASIC | FULL

Update requires: No interruption

EventTypeIds

与该通知规则关联的事件类型的列表。有关事件类型和 ID 的完整列表,请参阅开发人员工具控制台用户指南 中的通知概念

必需:是

类型:字符串列表

Update requires: No interruption

Name

通知规则的名称。通知规则名称在您的 AWS 账户中必须是唯一的。

必需:是

类型:字符串

最低1

最高64

模式[A-Za-z0-9\-_ ]+$

Update requires: No interruption

Resource

要与通知规则关联的资源的 Amazon 资源名称 (ARN)。支持的资源包括 AWS CodePipeline 中的管道、AWS CodeCommit 中的存储库以及 AWS CodeBuild 中的构建项目。

必需:是

类型:字符串

模式^arn:aws[^:\s]*:[^:\s]*:[^:\s]*:[0-9]{12}:[^\s]+$

Update requires: Replacement

Status

通知规则的状态。默认值为 ENABLED。如果状态设置为 DISABLED,则不会为通知规则发送通知。

必需:否

类型:字符串

允许的值DISABLED | ENABLED

Update requires: No interruption

Tags

要应用于该通知规则的标签列表。键名称不能以“aws”开头。

必需:否

类型:Json

Update requires: Replacement

Targets

要与通知规则关联的 Amazon SNS 主题和 AWS Chatbot 客户端的 Amazon 资源名称 (ARN) 列表。

必需:是

类型Target 列表

最高10

Update requires: No interruption

返回值

Ref

在向 Ref 内部函数提供该资源的逻辑 ID 时,Ref 返回通知规则 ARN。

示例

示例

以下示例创建一个名为 My Notification Rule for Comments on Commits 的通知规则。通知规则是使用键值对标记的,以指示哪个团队拥有该规则。

JSON

{ "Type": "AWS::CodeStarNotifications::NotificationRule", "Properties": { "Name": "My Notification Rule for Comments on Commits", "DetailType": "FULL", "Resource": "arn:aws:codecommit:us-east-2:123456789012:MyDemoRepo", "EventTypeIds": [ "codecommit-repository-comments-on-commits" ], "Targets": [ { "TargetType": "SNS", "TargetAddress": { "Fn::Sub": "arn:aws:sns:us-east-2:123456789012:MyNotificationTopic" } } ], "Tags": { "Team": "Saanvi" } } }

YAML

Type: 'AWS::CodeStarNotifications::NotificationRule' Properties: Name: 'My Notification Rule for Comments on Commits' DetailType: FULL Resource: 'arn:aws:codecommit:us-east-2:123456789012:MyDemoRepo' EventTypeIds: - codecommit-repository-comments-on-commits Targets: - TargetType: SNS TargetAddress: 'Fn::Sub': 'arn:aws:sns:us-east-2:123456789012:MyNotificationTopic' Tags: Team: Saanvi