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

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

Schedule

描述 Schedule 事件源类型的对象，它将您的状态机设置为按计划触发的 EventBridge 规则的目标。有关更多信息，请参阅《Amazon EventBridge 用户指南》中的什么是 Amazon 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
  RoleArn: String
  Schedule: String
  State: String
  Target: Target

属性

DeadLetterConfig

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

类型：DeadLetterConfig

必需：否

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

Description

规则的描述。

类型：字符串

必需：否

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

Enabled

指示是否启用规则。

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

注意

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

类型：布尔值

必需：否

Amazon CloudFormation 兼容性：此属性类似于 AWS::Events::Rule 资源的 State 属性。如果此属性设置为 true，则 Amazon SAM 传递 ENABLED，否则传递 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::Rule Target 数据类型的 RetryPolicy 属性。

RoleArn

在调用计划时 EventBridge 调度器将用于该目标的 IAM 角色的 ARN。

类型：RoleArn

必需：否。如果未提供，则将创建并使用新角色。

Amazon CloudFormation 兼容性：此属性直接传递给 AWS::Scheduler::Schedule Target 数据类型的 RoleArn 属性。

Schedule

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

类型：字符串

必需：是

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

State

规则的状态。

接受的值：DISABLED | ENABLED

注意

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

类型：字符串

必需：否

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

Target

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

类型：目标

必需：否

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

示例

CloudWatch 计划事件

CloudWatch 计划事件示例

YAML

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