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

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

ScheduleV2

描述ScheduleV2事件源类型的对象，它将您的无服务器函数设置为按计划触发的 Amazon S EventBridge cheduler 事件的目标。有关更多信息，请参阅什么是 Amazon S EventBridge 计划程序？ 在《EventBridge 调度程序用户指南》中。

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

语法

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

属性

DeadLetterConfig

配置 Amazon Simple Queue Service (Amazon SQS) 队列，该队列将在目标调用失败后 EventBridge 发送事件。例如，当向不存在的 Lambda 函数发送事件时，或者没有足够的权限调用 Lambda 函数时 EventBridge ，调用可能会失败。有关更多信息，请参阅《调度程序用户指南》中的为 EventBridge 调度器配置死信队列。EventBridge

注意

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

类型：DeadLetterConfig

必需：否

Amazon CloudFormation兼容性：此属性类似于AWS::Scheduler::ScheduleTarget数据类型的DeadLetterConfig属性。此属性的Amazon SAM版本包括其他子属性，以防你Amazon SAM想为自己创建死信队列。

Description

计划的描述。

类型：字符串

必需：否

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

EndDate

日程可以调用其目标的日期，以 UTC 为单位。根据调度的重复表达式，调用可能会在EndDate您指定的日期或之前停止。

类型：字符串

必需：否

Amazon CloudFormation兼容性：此属性直接传递给AWS::Scheduler::Schedule资源的EndDate属性。

FlexibleTimeWindow

允许配置可在其中调用时间表的窗口。

类型：FlexibleTimeWindow

必需：否

Amazon CloudFormation兼容性：此属性直接传递给AWS::Scheduler::Schedule资源的FlexibleTimeWindow属性。

GroupName

与该计划关联的计划组的名称。如果未定义，则使用默认组。

类型：字符串

必需：否

Amazon CloudFormation兼容性：此属性直接传递给AWS::Scheduler::Schedule资源的GroupName属性。

Input

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

类型：字符串

必需：否

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

KmsKeyArn

将用于加密客户数据的 KMS 密钥的 ARN。

类型：字符串

必需：否

Amazon CloudFormation兼容性：此属性直接传递给AWS::Scheduler::Schedule资源的KmsKeyArn属性。

Name

计划的名称。如果未指定名称，Amazon SAM将以以下格式生成一个名称，Function-Logical-IDEvent-Source-Name并使用该 ID 作为计划名称。

类型：字符串

必需：否

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

PermissionsBoundary

用于为角色设置权限边界的策略的 ARN。

注意

如果已定义，PermissionsBoundary则Amazon SAM将对调度程序计划的目标 IAM 角色应用相同的边界。

类型：字符串

必需：否

Amazon CloudFormation兼容性：此属性直接传递给AWS::IAM::Role资源的PermissionsBoundary属性。

RetryPolicy

包含有关重试策略设置的信息的 RetryPolicy 对象。

类型：RetryPolicy

必需：否

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

RoleArn

计划计划被调用时 EventBridge 计划程序将用于目标的 IAM 角色的 ARN。

类型：RoleArn

必需：否

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

ScheduleExpression

决定运行计划计划事件的时间和频率的计划表达式。

类型：字符串

必需：是

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

ScheduleExpressionTimezone

评估调度表达式的时区。

类型：字符串

必需：否

Amazon CloudFormation兼容性：此属性直接传递给AWS::Scheduler::Schedule资源的ScheduleExpressionTimezone属性。

StartDate

以 UTC 为单位的日期，在此之后计划可以开始调用目标。根据调度的重复表达式，调用可能会在StartDate您指定的时间或之后发生。

类型：字符串

必需：否

Amazon CloudFormation兼容性：此属性直接传递给AWS::Scheduler::Schedule资源的StartDate属性。

State

计划程序计划的状态。

可接受的值：DISABLED | ENABLED

类型：字符串

必需：否

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

示例

定义 ScheduleV2 资源的基本示例

Resources:
  Function:
    Properties:
      ...
      Events:
        ScheduleEvent:
          Type: ScheduleV2
          Properties:
            ScheduleExpression: "rate(1 minute)"
        ComplexScheduleEvent:
          Type: ScheduleV2
          Properties:
            ScheduleExpression: rate(1 minute)
            FlexibleTimeWindow:
              Mode: FLEXIBLE
              MaximumWindowInMinutes: 5
            StartDate: '2022-12-28T12:00:00.000Z'
            EndDate: '2023-01-28T12:00:00.000Z'
            ScheduleExpressionTimezone: UTC
            RetryPolicy:
              MaximumRetryAttempts: 5
              MaximumEventAgeInSeconds: 300
            DeadLetterConfig:
              Type: SQS