メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::Lambda::EventSourceMapping

AWS::Lambda::EventSourceMapping リソースは、AWS Lambda (Lambda) 関数のイベントのソースとしてストリームを指定します。ストリームは、Kinesis ストリームまたはAmazon DynamoDB (DynamoDB) ストリームとなります。Lambda は、レコードがストリームにポストされると関連付けられた関数を呼び出します。詳細については、COPY コマンドのリファレンスの「CreateEventSourceMapping」(AWS Lambda Developer Guide) を参照してください。

構文

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

JSON

Copy
{ "Type" : "AWS::Lambda::EventSourceMapping", "Properties" : { "BatchSize" : Integer, "Enabled" : Boolean, "EventSourceArn" : String, "FunctionName" : String, "StartingPosition" : String } }

YAML

Copy
Type: "AWS::Lambda::EventSourceMapping" Properties: BatchSize: Integer Enabled: Boolean EventSourceArn: String FunctionName: String StartingPosition: String

プロパティ

BatchSize

関数を呼び出すときに、Lambda がイベントのソースから取得するレコードの最大数。関数はイベントおよび取得されたすべてのレコードを受信します。デフォルト値および有効な値については、「CreateEventSourceMapping」(AWS Lambda Developer Guide) を参照してください。

Required: No

Type: Integer

更新に伴う要件: 中断はありません。

Enabled

Lambda がイベントソースのポーリングを開始するかどうかを示します。

Required: No

Type: Boolean

更新に伴う要件: 中断はありません。

EventSourceArn

イベントソースである Kinesis の Amazon リソースネーム (ARN) または DynamoDB ストリーム。このストリームに追加されているレコードであれば、Lambda 関数を呼び出すことができます。詳細については、COPY コマンドのリファレンスの「CreateEventSourceMapping」(AWS Lambda Developer Guide) を参照してください。

Required: Yes

Type: String

更新に伴う要件: 置換

FunctionName

Lambda 関数の名前または ARM で、Lambda がストリームでイベントを検出すると呼び出されます。

Required: Yes

Type: String

更新に伴う要件: 中断はありません。

StartingPosition

Lambda が読み取りを開始するストリームの場所。有効な値については、「CreateEventSourceMapping」(AWS Lambda Developer Guide) を参照してください。

Required: Yes

Type: String

更新に伴う要件: 置換

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref によりリソース名が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

次の例では、Kinesis ストリームを Lambda 関数に関連付けます。

JSON

Copy
"EventSourceMapping": { "Type": "AWS::Lambda::EventSourceMapping", "Properties": { "EventSourceArn" : { "Fn::Join" : [ "", [ "arn:aws:kinesis:", { "Ref" : "AWS::Region" }, ":", { "Ref" : "AWS::AccountId" }, ":stream/", { "Ref" : "KinesisStream" }] ] }, "FunctionName" : { "Fn::GetAtt" : ["LambdaFunction", "Arn"] }, "StartingPosition" : "TRIM_HORIZON" } }

YAML

Copy
EventSourceMapping: Type: "AWS::Lambda::EventSourceMapping" Properties: EventSourceArn: Fn::Join: - "" - - "arn:aws:kinesis:" - Ref: "AWS::Region" - ":" - Ref: "AWS::AccountId" - ":stream/" - Ref: "KinesisStream" FunctionName: Fn::GetAtt: - "LambdaFunction" - "Arn" StartingPosition: "TRIM_HORIZON"

このページの内容: