EventBridgeRule - Amazon Serverless Application Model
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

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

EventBridgeRule

描述EventBridgeRule事件源类型,它将无服务器功能设置为 Amazon EventBridge 规则的目标。有关更多信息,请参阅 。什么是 Amazon EventBridge?中的Amazon EventBridge 用户指南.

Amazon SAM生成AWS::Events::Rule设置此事件类型时的资源。

Syntax

要在您的Amazon Serverless Application Model(Amazon SAM) 模板,请使用以下语法。

Properties

DeadLetterConfig

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

注意:这些区域有:AWS::Serverless::Function资源类型具有类似的数据类型,DeadLetterQueue,它处理成功调用目标 Lambda 函数后发生的故障。这些类型的失败示例包括 Lambda 限制或 Lambda 目标函数返回的错误。有关函数的更多信息DeadLetterQueue属性,请参阅Amazon Lambda函数死信队列中的Amazon Lambda开发人员指南.

类型DeadLetterConfig

必需:否

Amazon CloudFormation兼容性:此属性类似于DeadLetterConfig的财产AWS::Events::Rule Target数据类型。这些区域有:Amazon SAM此属性的版本包括额外的子属性,以防你想Amazon SAM为你创建死信队列。

EventBusName

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

类型:String

必需:否

默认值:默认事件总线

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

Input

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

类型:String

必需:否

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

InputPath

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

类型:String

必需:否

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

Pattern

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

类型EventPattern

必需:是

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

RetryPolicy

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

类型RetryPolicy

必需:否

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

Target

这些区域有:Amazon在触发规则时,EventBridge 调用的资源。您可以使用此属性指定目标的逻辑 ID。如果未指定此属性,那么Amazon SAM将生成目标的逻辑 ID。

类型目标

必需:否

Amazon CloudFormation兼容性:此属性类似于Targets的财产AWS::Events::Rule资源。这些区域有:Amazon SAM此属性的版本只允许您指定单个目标的逻辑 ID。

Examples

EventBridgeRule

以下是一个示例:EventBridgeRule事件源类型。

YAML

EBRule: Type: EventBridgeRule Properties: Input: '{"Key": "Value"}' Pattern: detail: state: - terminated RetryPolicy: MaximumRetryAttempts: 5 MaximumEventAgeInSeconds: 900 DeadLetterConfig: Type: SQS QueueLogicalId: EBRuleDLQ Target: Id: MyTarget