EventBridgeRule - AWS Serverless Application Model

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

EventBridgeRule

描述 EventBridgeRule 事件源类型的对象,它将状态机设置为 Amazon EventBridge 规则的目标。有关更多信息,请参阅《Amazon EventBridge 用户指南》中的什么是 Amazon EventBridge?

如果设置了此事件类型,AWS SAM 会生成 AWS::Events::Rule 资源。

语法

要在您的 AWS Serverless Application Model (AWS SAM) 模板中声明此实体,请使用以下语法。

属性

DeadLetterConfig

配置 Amazon Simple Queue Service (Amazon SQS) 队列,其中 EventBridge 在目标调用失败后向该队列发送事件。例如,在向不存在的 Lambda 函数发送事件或 EventBridge 调用 Lambda 函数的权限不足时,调用可能会失败。有关更多信息,请参阅《Amazon EventBridge 用户指南》中的事件重试策略和使用死信队列

类型DeadLetterConfig

必需:否

CloudFormation 兼容性:此属性类似于 AWS::Events::Rule Target 数据类型的 DeadLetterConfig 属性。此属性的 AWS SAM 版本包括其他子属性,以备您想要 AWS SAM 创建死信队列时使用。

EventBusName

要与该规则关联的事件总线。如果省略此属性,则 AWS SAM 使用默认事件总线。

类型:字符串

必需:否

默认:默认事件总线

CloudFormation 兼容性:此属性直接传递给 AWS::Events::Rule 资源的 EventBusName 属性。

Input

传递到目标的有效 JSON 文本。如果使用此属性,则不会将事件文本本身的任何内容传递到目标。

类型:字符串

必需:否

CloudFormation 兼容性:此属性直接传递给 AWS::Events::Rule Target 资源的 Input 属性。

InputPath

当您不希望将整个匹配事件传递给目标时,请使用 InputPath 属性描述要传递事件的哪一部分。

类型:字符串

必需:否

CloudFormation 兼容性:此属性直接传递给 AWS::Events::Rule Target 资源的 InputPath 属性。

InputTransformer

使您可以根据特定事件数据向目标提供自定义输入的设置。您可以从事件中提取一个或多个键值对,然后使用该数据将自定义输入发送到目标。有关更多信息,请参阅《Amazon EventBridge 用户指南》中的 Amazon EventBridge 输入转换

类型InputTransformer

必需:否

CloudFormation 兼容性:此属性直接传递给 AWS::Events::Rule Target 数据类型的 InputTransformer 属性。

Pattern

描述哪些事件路由到指定目标。有关更多信息,请参阅《Amazon EventBridge 用户指南》中的 EventBridge 中的事件和事件模式

类型EventPattern

必需:是

CloudFormation 兼容性:此属性直接传递给 AWS::Events::Rule 资源的 EventPattern 属性。

RetryPolicy

包含有关重试策略设置的信息的 RetryPolicy 对象。有关更多信息,请参阅《Amazon EventBridge 用户指南》中的事件重试策略和使用死信队列

类型RetryPolicy

必需:否

CloudFormation 兼容性:此属性直接传递给 AWS::Events::Rule Target 数据类型的 RetryPolicy 属性。

RuleName

规则的名称。

类型:字符串

必需:否

CloudFormation 兼容性:此属性直接传递给 AWS::Events::Rule 资源的 Name 属性。

State

规则的状态。

有效值[ DISABLED | ENABLED ]

类型:字符串

必需:否

CloudFormation 兼容性:此属性直接传递给 AWS::Events::Rule 资源的 State 属性。

Target

触发规则时 EventBridge 调用的 AWS 资源。您可以使用此属性来指定目标的逻辑 ID。如果未指定此属性,则 AWS SAM 生成目标的逻辑 ID。

类型目标

必需:否

CloudFormation 兼容性:此属性类似于 AWS::Events::Rule 资源的 Targets 属性。此属性的 AWS SAM 版本仅允许您指定单个目标的逻辑 ID。

示例

EventBridgeRule

以下是 EventBridgeRule 事件源类型的示例。

YAML

EBRule: Type: EventBridgeRule Properties: Input: '{"Key": "Value"}' Pattern: detail: state: - terminated