Schedule - Amazon Serverless Application Model
语法属性示例
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

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

Schedule

描述Schedule事件源类型的对象，它将您的无服务器函数设置为按计划触发的 EventBridge 规则的目标。有关更多信息，请参阅 Amazon 是什么 EventBridge？ 在亚马逊 EventBridge 用户指南中。

Amazon Serverless Application Model(Amazon SAM) 在设置此事件类型时生成AWS::Events::Rule资源。

语法

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

YAML

  DeadLetterConfig: DeadLetterConfig
  Description: String
  Enabled: Boolean
  Input: String
  Name: String
  RetryPolicy: RetryPolicy
  Schedule: String
  State: String

属性

DeadLetterConfig

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

注意

AWS::Serverless::Function资源类型具有相似的数据类型DeadLetterQueue，用于处理成功调用目标 Lambda 函数后发生的故障。此类故障的示例包括 Lambda 限制或 Lambda 目标函数返回的错误。有关函数DeadLetterQueue属性的更多信息，请参阅《Amazon Lambda开发者指南》中的Amazon Lambda函数死信队列。

类型：DeadLetterConfig

必填项：否

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

Description

规则的描述。

类型：字符串

必填项：否

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

Enabled

指示是否启用规则。

要禁用该规则，请将此属性设置为false。

注意

指定Enabled或State属性，但不能同时指定两者。

类型：布尔值

必填项：否

Amazon CloudFormation兼容性：此属性类似于AWS::Events::Rule资源的State属性。如果将此属性设置为 thtrue enAmazon SAM passENABLED，否则通过DISABLED。

Input

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

类型：字符串

必填项：否

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

Name

规则的名称。如果不指定名称，则 Amazon CloudFormation 生成一个唯一物理 ID 并将该 ID 用作规则名称。

类型：字符串

必填项：否

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

RetryPolicy

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

类型：RetryPolicy

必填项：否

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

Schedule

决定运行规则的时间和频率的计划表达式。有关更多信息，请参阅规则的计划表达式。

类型：字符串

必填项：是

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

State

规则的状态。

可接受的值：DISABLED | ENABLED

注意

指定Enabled或State属性，但不能同时指定两者。

类型：字符串

必填项：否

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

示例

CloudWatch 计划事件

CloudWatch 计划事件示例

YAML

CWSchedule:
  Type: Schedule
  Properties:
    Schedule: 'rate(1 minute)'
    Name: TestSchedule
    Description: test schedule
    Enabled: false