AWS CloudFormation
ユーザーガイド (API バージョン 2010-05-15)

AWS::Lambda::EventSourceMapping

AWS::Lambda::EventSourceMapping リソースは、イベントソースと AWS Lambda 関数間のマッピングを作成します。Lambda は、イベントソースから項目を読み込み、関数をトリガーします。詳細については、AWS Lambda Developer Guide の「AWS Lambda イベントソースマッピング」を参照してください。

構文

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

JSON

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

YAML

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

プロパティ

BatchSize

1 回のバッチで取得する項目の最大数。

  • Amazon Kinesis – デフォルト 100。最大 10,000。

  • Amazon DynamoDB Streams – デフォルト 100。最大 1,000。

  • Amazon Simple Queue Service – デフォルト 10。最大 10。

Required: No

Type: Integer

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

Enabled

ポーリングと呼び出しを一時停止するように false を設定します。

Required: No

Type: Boolean

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

EventSourceArn

イベントソースの Amazon リソースネーム (ARN)。

  • Amazon Kinesis – データストリームまたはストリームコンシューマーの ARN。

  • Amazon DynamoDB ストリーム – ストリームの ARN。

  • Amazon Simple Queue Service – キューの ARN。

Required: Yes

Type: String

更新に伴う要件: 置換

FunctionName

Lambda 関数の名前。

名前の形式

  • 関数名 - MyFunction.

  • 関数 ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • バージョンまたはエイリアス ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • 一部の ARN - 123456789012:function:MyFunction.

Required: Yes

Type: String

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

StartingPosition

読み取りを開始するストリームの場所。Amazon Kinesis および Amazon DynamoDB Streams ソースの場合は必須です。AT_TIMESTAMP は Kinesis ストリームでのみサポートされています。

有効な値: TRIM_HORIZON | LATEST | AT_TIMESTAMP

Required: No

Type: String

更新に伴う要件: 置換

戻り値

参照番号

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

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

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

JSON

"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

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"

このページの内容: