Schedule

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

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

構文

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

YAML

  DeadLetterConfig: DeadLetterConfig
  Description: String
  Enabled: Boolean
  Input: String
  Name: String
  RetryPolicy: RetryPolicy
  Schedule: String
  State: String

プロパティ

DeadLetterConfig

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

注記

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

タイプ: 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