EventSource

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

構文

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

YAML

  Properties: S3 | SNS | Kinesis | DynamoDB | SQS | Api | Schedule | ScheduleV2 | CloudWatchEvent | EventBridgeRule | CloudWatchLogs | IoTRule | AlexaSkill | Cognito | HttpApi | MSK | MQ | SelfManagedKafka
  Type: String

プロパティ

Properties

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

タイプ: S3 | SNS | Kinesis | DynamoDB | SQS | Api | Schedule | ScheduleV2 | CloudWatchEvent | EventBridgeRule | CloudWatchLogs | IoTRule | AlexaSkill | Cognito | HttpApi | MSK | MQ | SelfManagedKafka

必須: はい

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

Type

イベントタイプです。

有効な値: S3、SNS、Kinesis、DynamoDB、SQS、Api、Schedule、ScheduleV2、CloudWatchEvent、CloudWatchLogs、IoTRule、AlexaSkill、Cognito、EventBridgeRule、HttpApi、MSK、MQ、SelfManagedKafka

タイプ: 文字列

必須: はい

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

例

APIEvent

API Event の使用例

YAML

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