ScheduleV2 - AWS Serverless Application Model
構文プロパティ例

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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) テンプレートでこのエンティティを宣言するには、次の構文を使用します。

プロパティ

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

必須: いいえ

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

Description

スケジュールの説明。

型: 文字列

必須: いいえ

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

EndDate

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

型: 文字列

必須: いいえ

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

FlexibleTimeWindow

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

タイプ: FlexibleTimeWindow

必須: いいえ

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

GroupName

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

型: 文字列

必須: いいえ

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

Input

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

型: 文字列

必須: いいえ

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

KmsKeyArn

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

型: 文字列

必須: いいえ

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

Name

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

型: 文字列

必須: いいえ

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

OmitName

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

タイプ: ブール

必須: いいえ

デフォルト: false

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

PermissionsBoundary

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

注記

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

型: 文字列

必須: いいえ

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

RetryPolicy

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

タイプ: RetryPolicy

必須: いいえ

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

RoleArn

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

タイプ: RoleArn

必須: いいえ

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

ScheduleExpression

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

型: 文字列

必須: はい

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

ScheduleExpressionTimezone

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

型: 文字列

必須: いいえ

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

StartDate

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

型: 文字列

必須: いいえ

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

State

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

使用できる値: DISABLED | ENABLED

型: 文字列

必須: いいえ

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 には、スタック名は含まれません。