本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
Schedule
描述Schedule事件源类型,它将无服务器函数设置为按计划触发的 EventBridge 规则的目标。有关更多信息,请参阅 。什么是 Amazon EventBridge?中的Amazon EventBridge 用户指南.
Amazon Serverless Application Model(Amazon SAM) 生成AWS::Events::Rule设置此事件类型时的资源。
语法
要在您的Amazon Serverless Application Model(Amazon SAM) 模板,请使用以下语法。
YAML
DeadLetterConfig:DeadLetterConfigDescription:StringEnabled:BooleanInput:StringName:StringRetryPolicy:RetryPolicySchedule:String
属性
-
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开发人员指南.必需:否
Amazon CloudFormation兼容性:此属性类似于
DeadLetterConfig的财产AWS::Events::RuleTarget数据类型。这些区域有:Amazon SAM此属性的版本包括额外的子属性,以防你想Amazon SAM为你创建死信队列。 -
Description -
规则的描述。
类型:字符串
必需:否
Amazon CloudFormation兼容性:此属性将直接传递给
Description的财产AWS::Events::Rule资源。 -
Enabled -
指示是否启用规则。
要禁用规则,请将此属性设置为
false.类型:Boolean
必需:否
Amazon CloudFormation兼容性:此属性类似于
State的财产AWS::Events::Rule资源。如果此属性设置为true然后Amazon SAM通行证ENABLED,否则它会通过DISABLED. -
Input -
传递到目标的有效 JSON 文本。如果使用此属性,则不会将事件文本本身的任何内容传递到目标。
类型:字符串
必需:否
Amazon CloudFormation兼容性:此属性将直接传递给
Target的财产AWS::Events::Rule Target资源。 -
Name -
规则的名称。如果不指定名称,则 Amazon CloudFormation 生成一个唯一物理 ID 并将该 ID 用作规则名称。
类型:字符串
必需:否
Amazon CloudFormation兼容性:此属性将直接传递给
Name的财产AWS::Events::Rule资源。 -
RetryPolicy -
包含有关重试策略设置的信息的
RetryPolicy对象。有关更多信息,请参阅 。事件重试策略和使用死信队列中的Amazon EventBridge 用户指南.类型:RetryPolicy
必需:否
Amazon CloudFormation兼容性:此属性将直接传递给
RetryPolicy的财产AWS::Events::RuleTarget数据类型。 -
Schedule -
决定运行规则的时间和频率的计划表达式。有关更多信息,请参阅规则的计划表达式。
类型:字符串
必需:是
Amazon CloudFormation兼容性:此属性将直接传递给
ScheduleExpression的财产AWS::Events::Rule资源。
示例
CloudWatch Event Event
CloudWatch Schedule Event Event
YAML
CWSchedule: Type: Schedule Properties: Schedule: 'rate(1 minute)' Name: TestSchedule Description: test schedule Enabled: false