翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ScheduleV2
ScheduleV2
イベントソースタイプを説明するオブジェクト。これにより、サーバーレス関数がスケジュールに従ってトリガーされる Amazon EventBridge Scheduler イベントのターゲットとして設定されます。詳細については、ス EventBridge ケジューラユーザーガイドの「Amazon Scheduler とはEventBridge 」を参照してください。
このイベントタイプが設定されていると、AWS Serverless Application Model (AWS SAM) は AWS::Scheduler::Schedule リソースを生成します。
構文
AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。
YAML
DeadLetterConfig:
DeadLetterConfig
Description:String
EndDate:String
FlexibleTimeWindow:FlexibleTimeWindow
GroupName:String
Input:String
KmsKeyArn:String
Name:String
OmitName:Boolean
PermissionsBoundary:String
RetryPolicy:RetryPolicy
RoleArn:String
ScheduleExpression:String
ScheduleExpressionTimezone:String
StartDate:String
State:String
プロパティ
-
DeadLetterConfig
-
Amazon Simple Queue Service (Amazon SQS) キューを設定します。 は、ターゲット呼び出しが失敗するとイベント EventBridge を送信します。呼び出しは、存在しない Lambda 関数にイベントを送信した場合や、Lambda 関数を呼び出すための十分なアクセス許可 EventBridge がない場合などに失敗する可能性があります。詳細については、ス EventBridge ケジューラユーザーガイドの「スケジューラのデッドレターキューの設定EventBridge 」を参照してください。
注記
AWS::Serverless::Function リソースタイプには
DeadLetterQueue
という同じようなデータ型があります。これは、ターゲット Lambda 関数の呼び出しが成功した後で発生する失敗を処理します。これらのタイプの失敗の例には、Lambda のスロットリングや、Lambda ターゲット関数によって返されるエラーなどがあります。関数のDeadLetterQueue
プロパティの詳細については、「AWS Lambda デベロッパーガイド」の「デッドレターキュー」を参照してください。と入力します。 DeadLetterConfig
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::Scheduler::Schedule
Target
データ型のDeadLetterConfig
プロパティに似ています。このプロパティの AWS SAM バージョンには、AWS SAM にデッドレターキューを作成させる場合のために、追加のサブプロパティが含まれています。 -
Description
-
スケジュールの説明。
タイプ: 文字列
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::Scheduler::Schedule
リソースのDescription
プロパティに直接渡されます。 -
EndDate
-
スケジュールがターゲットを呼び出すことができる日付 (UTC)。スケジュールの繰り返し式によっては、指定した EndDate またはそれより前に呼び出しが停止する場合があります。
タイプ: 文字列
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::Scheduler::Schedule
リソースのEndDate
プロパティに直接渡されます。 -
FlexibleTimeWindow
-
スケジュールを呼び出すことができるウィンドウを設定できます。
と入力します。 FlexibleTimeWindow
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::Scheduler::Schedule
リソースのFlexibleTimeWindow
プロパティに直接渡されます。 -
GroupName
-
このスケジュールに関連付けるスケジュールグループの名前。定義されていない場合、デフォルトグループが使用されます。
タイプ: 文字列
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::Scheduler::Schedule
リソースのGroupName
プロパティに直接渡されます。 -
Input
-
ターゲットに渡された有効な JSON テキストです。このプロパティを使用する場合、イベントテキスト自体からはターゲットに何も渡されません。
タイプ: 文字列
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::Scheduler::Schedule Target
リソースのInput
プロパティに直接渡されます。 -
KmsKeyArn
-
お客様のデータの暗号化に使用する KMS キーの ARN。
タイプ: 文字列
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::Scheduler::Schedule
リソースのKmsKeyArn
プロパティに直接渡されます。 -
Name
-
スケジュールの名前。名前を指定しない場合、AWS SAM は
の形式で名前を生成し、その ID をスケジュール名に使用します。Function-Logical-ID
Event-Source-Name
タイプ: 文字列
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::Scheduler::Schedule
リソースのName
プロパティに直接渡されます。 OmitName
-
デフォルトでは、 は
<Function-logical-IDTAKevent-source-name>
形式のスケジュール名AWS SAMを生成して使用します。このプロパティをにtrue
設定すると、AWS CloudFormation は一意の固有の物理 ID を生成し、代わりにその物理 ID をスケジュール名として使用します。タイプ: ブール
必須: いいえ
デフォルト:
false
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
-
PermissionsBoundary
-
ロールのアクセス許可の境界を設定するために使用するポリシーの ARN。
注記
PermissionsBoundary
が定義されている場合、AWS SAM は同じ境界をスケジューラスケジュールのターゲット IAM ロールに適用します。タイプ: 文字列
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::IAM::Role
リソースのPermissionsBoundary
プロパティに直接渡されます。 -
RetryPolicy
-
再試行ポリシーの設定に関する情報が含まれた RetryPolicy オブジェクトです。
と入力します。 RetryPolicy
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::Scheduler::Schedule
Target
データ型のRetryPolicy
プロパティに直接渡されます。 -
RoleArn
-
スケジュールが呼び出されたときにス EventBridge ケジューラがターゲットに使用する IAM ロールの ARN。
と入力します。 RoleArn
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::Scheduler::Schedule
Target
データ型のRoleArn
プロパティに直接渡されます。 -
ScheduleExpression
-
スケジューラのスケジュールイベントがいつ、どのくらいの頻度で実行されるかを決定するスケジューリング式です。
タイプ: 文字列
必須: はい
AWS CloudFormation との互換性: このプロパティは、
AWS::Scheduler::Schedule
リソースのScheduleExpression
プロパティに直接渡されます。 -
ScheduleExpressionTimezone
-
スケジュール式が評価されるタイムゾーン。
タイプ: 文字列
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::Scheduler::Schedule
リソースのScheduleExpressionTimezone
プロパティに直接渡されます。 -
StartDate
-
スケジュールがターゲットの呼び出しを開始できる日付 (UTC)。スケジュールの繰り返し式によっては、指定した StartDate またはそれより後に呼び出しが発生する場合があります。
タイプ: 文字列
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::Scheduler::Schedule
リソースのStartDate
プロパティに直接渡されます。 -
State
-
スケジューラのスケジュールの状態。
使用できる値:
DISABLED | ENABLED
タイプ: 文字列
必須: いいえ
AWS 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