Schedule

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

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

注記

EventBridge は、新しいスケジューリング機能 Amazon EventBridge Schedulerを提供するようになりました。Amazon EventBridge Schedulerはサーバーレススケジューラで、一元管理型サービスからタスクを作成、実行、管理できます。 EventBridge Scheduler は高度にカスタマイズ可能で、より広範なターゲット API オペレーションと のセットにより、スケジュールされたルールよりも EventBridge スケーラビリティが向上しますAWS のサービス。

を使用して EventBridge Scheduler、スケジュールに従ってターゲットを呼び出すことをお勧めします。AWS SAM テンプレートでこのイベントソースタイプを定義するには、「ScheduleV2」を参照してください。

構文

AWS Serverless Application Model (AWS 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 プロパティの詳細については、「AWS Lambda デベロッパーガイド」の「デッドレターキュー」を参照してください。

と入力します。 DeadLetterConfig

必須: いいえ

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

Description

ルールの説明です。

タイプ: 文字列

必須: いいえ

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

Enabled

ルールが有効かどうかを示します。

ルールを無効にするには、このプロパティを false に設定します。

注記

Enabled プロパティと State プロパティは、両方ではなく、どちらか一方を指定してください。

タイプ: ブール

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Events::Rule リソースの State プロパティに似ています。このプロパティが true に設定されている場合は、AWS SAM が ENABLED を渡します。それ以外の場合は DISABLED を渡します。

Input

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

タイプ: 文字列

必須: いいえ

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

Name

ルールの名前です。名前を指定しない場合、AWS CloudFormation が一意の物理 ID を生成し、その ID をルール名として使用します。

タイプ: 文字列

必須: いいえ

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

RetryPolicy

再試行ポリシーの設定に関する情報が含まれた RetryPolicy オブジェクトです。詳細については、「Amazon EventBridge ユーザーガイド」の「イベントの再試行ポリシーとデッドレターキューの使用」を参照してください。

と入力します。 RetryPolicy

必須: いいえ

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

Schedule

ルールがいつ、どのくらいの頻度で実行されるかを決定するスケジューリング式です。詳細については、「Schedule Expressions for Rules」を参照してください。

タイプ: 文字列

必須: はい

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

State

ルールの状態。

使用できる値: DISABLED | ENABLED

注記

Enabled プロパティと State プロパティは、両方ではなく、どちらか一方を指定してください。

タイプ: 文字列

必須: いいえ

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

例

CloudWatch スケジュールイベント

CloudWatch スケジュールイベントの例

YAML

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