ScheduleV2

ScheduleV2 イベントソースタイプを説明するオブジェクトです。これは、サーバーレス関数をスケジュールに従ってトリガーする Amazon EventBridge スケジューライベントのターゲットとして設定します。詳細については、「EventBridge スケジューラユーザーガイド」の「What is Amazon EventBridge Scheduler?」(Amazon EventBridge スケジューラとは) を参照してください。

このイベントタイプが設定されていると、AWS Serverless Application Model (AWS SAM) は AWS::Scheduler::Schedule リソースを生成します。

構文

AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。

YAML

DeadLetterConfig: DeadLetterConfig
Description: String
EndDate: String
FlexibleTimeWindow: FlexibleTimeWindow
GroupName: String
Input: String
KmsKeyArn: String
Name: String
OmitName: Boolean
PermissionsBoundary: String
RetryPolicy: RetryPolicy
RoleArn: String
ScheduleExpression: String
ScheduleExpressionTimezone: String
StartDate: String
State: String

プロパティ

DeadLetterConfig

ターゲットの呼び出しに失敗した後で EventBridge がイベントを送信する Amazon Simple Queue Service (Amazon SQS) キューを設定します。呼び出しは、存在しない Lambda 関数にイベントを送信した場合、または Lambda 関数を呼び出すために十分な許可が EventBridge にない場合などに失敗します。詳細については、「EventBridge スケジューラユーザーガイド」の「Configuring a dead-letter queue for EventBridge Scheduler」(EventBridge スケジューラのデッドレターキューの設定) を参照してください。

注記

AWS::Serverless::Function リソースタイプには DeadLetterQueue という同じようなデータ型があります。これは、ターゲット Lambda 関数の呼び出しが成功した後で発生する失敗を処理します。これらのタイプの失敗の例には、Lambda のスロットリングや、Lambda ターゲット関数によって返されるエラーなどがあります。関数の DeadLetterQueue プロパティの詳細については、「AWS Lambda デベロッパーガイド」の「デッドレターキュー」を参照してください。

タイプ: DeadLetterConfig

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Scheduler::Schedule Target データ型の DeadLetterConfig プロパティに似ています。このプロパティの AWS SAM バージョンには、AWS SAM にデッドレターキューを作成させる場合のために、追加のサブプロパティが含まれています。

Description

スケジュールの説明。

型: 文字列

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Scheduler::Schedule リソースの Description プロパティに直接渡されます。

EndDate

スケジュールがターゲットを呼び出すことができる日付 (UTC)。スケジュールの繰り返し式によっては、指定した EndDate またはそれより前に呼び出しが停止する場合があります。

型: 文字列

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Scheduler::Schedule リソースの EndDate プロパティに直接渡されます。

FlexibleTimeWindow

スケジュールを呼び出すことができるウィンドウを設定できます。

タイプ: FlexibleTimeWindow

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Scheduler::Schedule リソースの FlexibleTimeWindow プロパティに直接渡されます。

GroupName

このスケジュールに関連付けるスケジュールグループの名前。定義されていない場合、デフォルトグループが使用されます。

型: 文字列

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Scheduler::Schedule リソースの GroupName プロパティに直接渡されます。

Input

ターゲットに渡された有効な JSON テキストです。このプロパティを使用する場合、イベントテキスト自体からはターゲットに何も渡されません。

型: 文字列

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Scheduler::Schedule Target リソースの Input プロパティに直接渡されます。

KmsKeyArn

お客様のデータの暗号化に使用する KMS キーの ARN。

型: 文字列

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Scheduler::Schedule リソースの KmsKeyArn プロパティに直接渡されます。

Name

スケジュールの名前。名前を指定しない場合、AWS SAM は Function-Logical-IDEvent-Source-Name の形式で名前を生成し、その ID をスケジュール名に使用します。

型: 文字列

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Scheduler::Schedule リソースの Name プロパティに直接渡されます。

OmitName

デフォルトの場合、AWS SAM は <Function-logical-ID><event-source-name> の形式でスケジュール名を生成して使用します。このプロパティをに true 設定すると、AWS CloudFormation は一意の固有の物理 ID  を生成し、代わりにその物理 ID をスケジュール名として使用します。

タイプ: ブール

必須: いいえ

デフォルト: false

AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。

PermissionsBoundary

ロールのアクセス許可の境界を設定するために使用するポリシーの ARN。

注記

PermissionsBoundary が定義されている場合、AWS SAM は同じ境界をスケジューラスケジュールのターゲット IAM ロールに適用します。

型: 文字列

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::IAM::Role リソースの PermissionsBoundary プロパティに直接渡されます。

RetryPolicy

再試行ポリシーの設定に関する情報が含まれた RetryPolicy オブジェクトです。

タイプ: RetryPolicy

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Scheduler::Schedule Target データ型の RetryPolicy プロパティに直接渡されます。

RoleArn

スケジュールが呼び出されたときに EventBridge スケジューラがターゲットとして使用する IAM ロールの ARN。

タイプ: RoleArn

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Scheduler::Schedule Target データ型の RoleArn プロパティに直接渡されます。

ScheduleExpression

スケジューラのスケジュールイベントがいつ、どのくらいの頻度で実行されるかを決定するスケジューリング式です。

型: 文字列

必須: はい

AWS CloudFormation との互換性: このプロパティは、AWS::Scheduler::Schedule リソースの ScheduleExpression プロパティに直接渡されます。

ScheduleExpressionTimezone

スケジュール式が評価されるタイムゾーン。

型: 文字列

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Scheduler::Schedule リソースの ScheduleExpressionTimezone プロパティに直接渡されます。

StartDate

スケジュールがターゲットの呼び出しを開始できる日付 (UTC)。スケジュールの繰り返し式によっては、指定した StartDate またはそれより後に呼び出しが発生する場合があります。

型: 文字列

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Scheduler::Schedule リソースの StartDate プロパティに直接渡されます。

State

スケジューラのスケジュールの状態。

使用できる値: DISABLED | ENABLED

型: 文字列

必須: いいえ

AWS 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

注記

生成された ScheduleV2 の物理 ID には、スタック名は含まれません。