Schedule - AWS Serverless Application Model

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

Schedule

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

AWS Serverless Application Model (AWS SAM) によりAWS::Events::Ruleこのイベントタイプが設定されると、リソースです。

Syntax

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

Properties

DeadLetterConfig

ターゲットの呼び出しに失敗した後、EventBridge がイベントを送信する Amazon Simple Queue Service (Amazon SQS) キューを設定します。たとえば、存在しない Lambda 関数にイベントを送信したり、EventBridge に Lambda 関数を呼び出すための十分な権限がない場合など、呼び出しが失敗することがあります。詳細については、「」を参照してください。イベントの再試行ポリシーとデッドレターキューの使用()Amazon EventBridge ユーザーガイド

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

タイプ: DeadLetterConfig

必須: いいえ

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

Description

ルールの説明。

タイプ: 文字列

必須: いいえ

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

Enabled

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

ルールを無効にするには、このプロパティをFalse

タイプ: ブール値

必須: いいえ

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

Input

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

タイプ: 文字列

必須: いいえ

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

Name

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

タイプ: 文字列

必須: いいえ

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

RetryPolicy

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

タイプ: RetryPolicy

必須: いいえ

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

Schedule

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

タイプ: 文字列

必須: はい

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

Examples

CloudWatch スケジュールイベント

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

YAML

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