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 」を参照してください。

タイプ： 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 を生成StateMachine-Logical-IDEvent-Source-Nameし、その ID をスケジュール名として使用します。

タイプ: 文字列

必須: いいえ

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

OmitName

デフォルトでは、 は <S tate-machine-logical-ID><event-source-name> 形式のスケジュール名 AWS SAM を生成して使用します。このプロパティを trueに設定すると、 は一意の物理 ID AWS CloudFormation を生成し、代わりにスケジュール名にそれを使用します。

タイプ: ブール

必須: いいえ

デフォルト: 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 リソースを定義する基本的な例

StateMachine:
  Type: AWS::Serverless::StateMachine
  Properties:
    Name: MyStateMachine
    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
    DefinitionUri:
      Bucket: sam-demo-bucket
      Key: my-state-machine.asl.json
      Version: 3
    Policies:
      - LambdaInvokePolicy:
          FunctionName: !Ref MyFunction