EventSource - AWS Serverless Application Model
構文プロパティ例

EventSource

ステートマシンをトリガーするイベントのソースを説明するオブジェクトです。各イベントは、1 つのタイプと、そのタイプに依存する一連のプロパティで構成されます。各イベントソースのプロパティの詳細については、そのタイプに対応するサブトピックを参照してください。

構文

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

プロパティ

Properties

このイベントマッピングのプロパティを説明するオブジェクトです。プロパティのセットは、定義された Type に準拠する必要があります。

タイプ: Schedule | ScheduleV2 | CloudWatchEvent | EventBridgeRule | Api

必須: はい

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

Type

イベントタイプです。

有効な値: Api、Schedule、ScheduleV2、CloudWatchEvent、EventBridgeRule

タイプ: 文字列

必須: はい

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

例

API

以下は、API タイプのイベントの例です。

YAML

ApiEvent:
  Type: Api
  Properties:
    Method: get
    Path: /group/{user}
    RestApiId: 
      Ref: MyApi