在 Amazon EventBridge 事件模式中筛选内容 - Amazon EventBridge
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

在 Amazon EventBridge 事件模式中筛选内容

Amazon EventBridge 支持使用事件模式进行声明式内容筛选。通过内容筛选,您可以编写仅在非常具体的条件下匹配事件的复杂事件模式。例如,您可以创建事件模式,在以下情况下与事件匹配:

  • 事件的某个字段在特定的数值范围内。

  • 事件来自特定 IP 地址。

  • 事件 JSON 中不存在特定字段。

重要

在中 EventBridge,可以创建可能导致 higher-than-expected 收费和限制的规则。例如,您可能无意中创建了一条规则,导致无限循环,规则会以递归方式触发,不会结束。假设您创建了一条规则,来检测 S3 桶中的 ACL 更改,然后触发软件以将 ACL 更改为所需状态。如果编写该规则时不小心,则 ACL 的后续更改将再次触发该规则,从而产生无限循环。

有关如何编写精确的规则和事件模式,以最大限度地减少此类意外结果的指导,请参阅定义 Amazon EventBridge 规则的最佳实践定义 Amazon EventBridge 事件模式时的最佳实践

前缀匹配

您可以根据事件源中值的前缀匹配事件。您可以对字符串值使用前缀匹配。

例如,以下事件模式将匹配 "time" 字段以 "2017-10-02" 开头的任何事件,例如 "time": "2017-10-02T18:43:48Z"

{ "time": [ { "prefix": "2017-10-02" } ] }

忽略大小写时进行前缀匹配

无论值开头的字符大小写如何,您也可以匹配前缀值,同时使用equals-ignore-caseprefix.

例如,以下事件模式将匹配service字段以字符串开头的任何事件EventB,以及EVENTBeventb、或这些字符的任何其他大小写。

{ "detail": {"service" : [{ "prefix": { "equals-ignore-case": "EventB" }}]} }

后缀匹配

您可以根据事件源中值的后缀匹配事件。您可以对字符串值使用后缀匹配。

例如,以下事件模式将匹配 "FileName" 字段以 .png 文件扩展名结尾的任何事件。

{ "FileName": [ { "suffix": ".png" } ] }

忽略大小写时进行后缀匹配

无论值结尾的字符大小写如何,您也可以匹配后缀值,同时使用equals-ignore-casesuffix.

例如,以下事件模式将匹配FileName字段以字符串结尾的任何事件.png,但也匹配这些字符.PNG的任何其他大写形式。

{ "detail": {"FileName" : [{ "suffix": { "equals-ignore-case": ".png" }}]} }

Anything-but 匹配

Anything-but 匹配可匹配除规则中提供的内容之外的任何内容。

您可以将 Anything-but 匹配与字符串和数值一起使用,包括仅包含字符串或仅包含数值的列表。

以下事件模式显示了 Anything-but 匹配与字符串和数字。

{ "detail": { "state": [ { "anything-but": "initializing" } ] } } { "detail": { "x-limit": [ { "anything-but": 123 } ] } }

以下事件模式显示了 Anything-but 匹配与一组字符串。

{ "detail": { "state": [ { "anything-but": [ "stopped", "overloaded" ] } ] } }

以下事件模式显示了 Anything-but 匹配与一组数字。

{ "detail": { "x-limit": [ { "anything-but": [ 100, 200, 300 ] } ] } }

除了在忽略大小写的同时匹配之外什么都没有

也可以与结合使用 equals-ignore-caseanything-but,以匹配字符串值,而不考虑字符大小写。

以下事件模式匹配包含字符串 “初始化”、“初始化”、“初始化” 或这些字符的任何其他大写字母的state字段。

{ "detail": {"state" : [{ "anything-but": { "equals-ignore-case": "initializing" }}]} }

您也可以equals-ignore-case与结合使用anything-but来匹配值列表:

{ "detail": {"state" : [{ "anything-but": { "equals-ignore-case": ["initializing", "stopped"] }}]} }

除了前缀匹配之外什么都没有

以下事件模式显示了与 "state" 字段中没有 "init" 前缀的任何事件相匹配的 Anything-but 匹配。

注意

Anything-but 匹配只能处理单个前缀,不能处理一组前缀。

{ "detail": { "state": [ { "anything-but": { "prefix": "init" } } ] } }

除了后缀匹配之外什么都没有

无论字符大小写如何,都可以与结合使用suffixanything-but来匹配字符串值。

注意

除了匹配之@@ 外的任何东西都只能使用单个后缀,而不是列表。

以下事件模式匹配以结尾的FileName字段的任何值.txt

{ "detail": { "FileName": [ { "anything-but": { "suffix": ".txt" } } ] } }

数值匹配

数值匹配适用于 JSON 数字值。仅限于 -5.0e9 和 +5.0e9(含)之间的值,精度为 15 位(小数点右侧为六位)。

以下代码显示的事件模式的数值匹配,仅匹配所有字段均为真的事件。

{ "detail": { "c-count": [ { "numeric": [ ">", 0, "<=", 5 ] } ], "d-count": [ { "numeric": [ "<", 10 ] } ], "x-limit": [ { "numeric": [ "=", 3.018e2 ] } ] } }

IP 地址匹配

可以将 IP 地址匹配用于 IPv4 和 IPv6 地址。以下事件模式显示的 IP 地址匹配,匹配以 10.0.0 开头并以 0 到 255 之间的数字结尾的 IP 地址。

{ "detail": { "sourceIPAddress": [ { "cidr": "10.0.0.0/24" } ] } }

Exists 匹配

Exists 匹配 用于确定事件的 JSON 中存在或不存在某个字段。

Exists 匹配仅适用于叶节点。它对于中间节点不起作用。

以下事件模式与任何具有 detail.state 字段的事件相匹配。

{ "detail": { "state": [ { "exists": true } ] } }

上一事件模式与以下事件匹配。

{ "version": "0", "id": "7bf73129-1428-4cd3-a780-95db273d1602", "detail-type": "EC2 Instance State-change Notification", "source": "aws.ec2", "account": "123456789012", "time": "2015-11-11T21:29:54Z", "region": "us-east-1", "resources": ["arn:aws:ec2:us-east-1:123456789012:instance/i-abcd1111"], "detail": { "instance-id": "i-abcd1111", "state": "pending" } }

上一事件模式与以下事件不匹配,因为它没有 detail.state 字段。

{ "detail-type": [ "EC2 Instance State-change Notification" ], "resources": [ "arn:aws:ec2:us-east-1:123456789012:instance/i-02ebd4584a2ebd341" ], "detail": { "c-count" : { "c1" : 100 } } }

E quals-ignore-case 匹配

无论大小写如何,E quals-ignore-case 匹配都适用于字符串值。

以下事件模式匹配 detail-type 字段与指定字符串相匹配(无论大小写如何)的任何事件。

{ "detail-type": [ { "equals-ignore-case": "ec2 instance state-change notification" } ] }

上一事件模式与以下事件匹配。

{ "detail-type": [ "EC2 Instance State-change Notification" ], "resources": [ "arn:aws:ec2:us-east-1:123456789012:instance/i-02ebd4584a2ebd341" ], "detail": { "c-count" : { "c1" : 100 } } }

使用通配符进行匹配

您可以使用通配符 (*) 匹配事件模式中的字符串值。

注意

目前,只有事件总线规则支持通配符。

在事件模式中使用通配符的注意事项:

  • 可以在给定的字符串值中指定任意数量的通配符;但是,不支持连续通配符。

  • EventBridge 支持使用反斜杠字符 (\) 来指定通配符过滤器中的文字 * 和\ 字符:

    • 字符串 \* 代表文字 * 字符

    • 字符串 \\ 代表文字 \ 字符

    不支持使用反斜杠对其他字符进行转义。

通配符和事件模式的复杂性

规则使用通配符的复杂程度是有限的。如果规则过于复杂,则InvalidEventPatternException在尝试创建规则时 EventBridge 返回。如果您的规则生成此类错误,请考虑使用以下指南来降低事件模式的复杂性:

  • 减少使用的通配符数量

    仅在确实需要匹配多个可能值的位置使用通配符。例如,考虑以下事件模式,您想匹配同一区域中的事件总线:

    { "EventBusArn": [ { "wildcard": "*:*:*:*:*:event-bus/*" } ] }

    在上述情况下,ARN 的许多部分将直接取决于您的事件总线所在的区域。因此,如果您使用 us-east-1 区域,则以下示例可能是不太复杂,但仍可与所需值匹配的模式:

    { "EventBusArn": [ { "wildcard": "arn:aws:events:us-east-1:*:event-bus/*" } ] }
  • 减少通配符后出现的重复字符序列

    使用通配符后多次出现相同的字符序列,会增加处理事件模式的复杂性。请修改您的事件模式,最大限度地减少重复序列。例如,考虑以下示例,该示例与任何用户的文件名为 doc.txt 的文件相匹配:

    { "FileName": [ { "wildcard": "/Users/*/dir/dir/dir/dir/dir/doc.txt" } ] }

    如果您知道 doc.txt 文件只会出现在指定路径中,则可以通过以下方式减少重复的字符序列:

    { "FileName": [ { "wildcard": "/Users/*/doc.txt" } ] }

具有多个匹配的复杂示例

您可以将多个匹配规则组合为更复杂的事件模式。例如,以下事件模式组合了 anything-butnumeric

{ "time": [ { "prefix": "2017-10-02" } ], "detail": { "state": [ { "anything-but": "initializing" } ], "c-count": [ { "numeric": [ ">", 0, "<=", 5 ] } ], "d-count": [ { "numeric": [ "<", 10 ] } ], "x-limit": [ { "anything-but": [ 100, 200, 300 ] } ] } }
注意

在构建事件模式时,如果您多次包含一个密钥,则最后一次引用将用于评估事件。例如,对于以下模式:

{ "detail": { "location": [ { "prefix": "us-" } ], "location": [ { "anything-but": "us-east" } ] } }

只有在评估 location 时才会考虑 { "anything-but": "us-east" }

具有 $or 匹配的复杂示例

您还可以创建复杂的事件模式,检查多个字段中是否有任何 字段值匹配。$or 用于创建事件模式,匹配多个字段中有任何值匹配的情况。

请注意,在 $or 构造中,您可以在各个字段的模式匹配中包含其他筛选器类型,例如数值匹配数组

满足以下任意条件时,匹配以下事件模式:

  • c-count 字段大于 0 或小于等于 5。

  • d-count 字段小于 10。

  • x-limit 字段等于 3.018e2。

{ "detail": { "$or": [ { "c-count": [ { "numeric": [ ">", 0, "<=", 5 ] } ] }, { "d-count": [ { "numeric": [ "<", 10 ] } ] }, { "x-limit": [ { "numeric": [ "=", 3.018e2 ] } ] } ] } }
注意

如果使用 $or 会导致超过 1000 个规则组合,接受事件模式(例如 PutRuleCreateArchiveUpdateArchiveTestEventPattern)的 API 会引发 InvalidEventPatternException

要确定事件模式中规则组合的数量,请将事件模式中每个 $or 数组的参数总数相乘。例如,上面的模式包含一个 $or 数组,带有三个参数,因此规则组合的总数也是三个。如果您再添加一个包含两个参数的 $or 数组,则规则组合总数将为六个。