翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
Schedule
Schedule イベントソースタイプを説明するオブジェクトです。これは、サーバーレス関数をスケジュールに従ってトリガーする Amazon EventBridge ルールのターゲットとして設定します。詳細については、Amazon EventBridge ユーザーガイドの「Amazon EventBridge とは」を参照してください。
このイベントタイプが設定されていると、AWS Serverless Application Model (AWS SAM) は AWS::Events::Rule リソースを生成します。
注記
EventBridge では、Amazon EventBridge Scheduler という新しいスケジューリング機能が提供されるようになりました。Amazon EventBridge Scheduler はサーバーレススケジューラで、一元化されたマネージドサービスからタスクを作成、実行、管理できます。EventBridge Scheduler は高度にカスタマイズ可能で、EventBridge のスケジュールルールよりもスケーラビリティが高く、ターゲット API オペレーションと AWS のサービス の範囲が広がります。
スケジュールに従ってターゲットを呼び出すには、EventBridge Scheduler を使用することをお勧めします。AWS SAM テンプレートでこのイベントソースタイプを定義するには、「ScheduleV2」を参照してください。
構文
AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。
YAML
DeadLetterConfig:DeadLetterConfigDescription:StringEnabled:BooleanInput:StringName:StringRetryPolicy:RetryPolicySchedule:StringState: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 デベロッパーガイド」の「デッドレターキュー」を参照してください。タイプ: DeadLetterConfig
必須: いいえ
CloudFormation との互換性: このプロパティは、
AWS::Events::RuleTargetデータ型のDeadLetterConfigプロパティに似ています。このプロパティの AWS SAM バージョンには、AWS SAM にデッドレターキューを作成させる場合のために、追加のサブプロパティが含まれています。 -
Description -
ルールの説明です。
タイプ: 文字列
必須: いいえ
CloudFormation との互換性: このプロパティは、
AWS::Events::RuleリソースのDescriptionプロパティに直接渡されます。 -
Enabled -
ルールが有効かどうかを示します。
ルールを無効にするには、このプロパティを
falseに設定します。注記
EnabledプロパティとStateプロパティは、両方ではなく、どちらか一方を指定してください。タイプ: ブール
必須: いいえ
CloudFormation との互換性: このプロパティは、
AWS::Events::RuleリソースのStateプロパティに似ています。このプロパティがtrueに設定されている場合は、AWS SAM がENABLEDを渡します。それ以外の場合はDISABLEDを渡します。 -
Input -
ターゲットに渡された有効な JSON テキストです。このプロパティを使用する場合、イベントテキスト自体からはターゲットに何も渡されません。
タイプ: 文字列
必須: いいえ
CloudFormation との互換性: このプロパティは、
AWS::Events::Rule TargetリソースのInputプロパティに直接渡されます。 -
Name -
ルールの名前です。名前を指定しない場合、CloudFormation が一意の物理 ID を生成し、その ID をルール名として使用します。
タイプ: 文字列
必須: いいえ
CloudFormation との互換性: このプロパティは、
AWS::Events::RuleリソースのNameプロパティに直接渡されます。 -
RetryPolicy -
再試行ポリシーの設定に関する情報が含まれた
RetryPolicyオブジェクトです。詳細については、Amazon EventBridge ユーザーガイドの「Event retry policy and using dead-letter queues」を参照してください。Type: RetryPolicy
必須: いいえ
CloudFormation との互換性: このプロパティは、
AWS::Events::RuleTargetデータ型のRetryPolicyプロパティに直接渡されます。 -
Schedule -
ルールがいつ、どのくらいの頻度で実行されるかを決定するスケジューリング式です。詳細については、「Schedule Expressions for Rules」を参照してください。
タイプ: 文字列
必須: はい
CloudFormation との互換性: このプロパティは、
AWS::Events::RuleリソースのScheduleExpressionプロパティに直接渡されます。 -
State -
ルールの状態。
使用できる値:
DISABLED | ENABLED注記
EnabledプロパティとStateプロパティは、両方ではなく、どちらか一方を指定してください。タイプ: 文字列
必須: いいえ
CloudFormation との互換性: このプロパティは、
AWS::Events::RuleリソースのStateプロパティに直接渡されます。
例
CloudWatch スケジュールイベント
CloudWatch スケジュールイベントの例
YAML
CWSchedule: Type: Schedule Properties: Schedule: 'rate(1 minute)' Name: TestSchedule Description: test schedule Enabled: false
