AWS::Lambda::EventSourceMapping
The AWS::Lambda::EventSourceMapping
resource creates a mapping between an event source and an AWS
Lambda function. Lambda reads items from the event source and triggers the function.
For details about each event source type, see the following topics.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Lambda::EventSourceMapping", "Properties" : { "BatchSize" :
Integer
, "BisectBatchOnFunctionError" :Boolean
, "DestinationConfig" :DestinationConfig
, "Enabled" :Boolean
, "EventSourceArn" :String
, "FunctionName" :String
, "MaximumBatchingWindowInSeconds" :Integer
, "MaximumRecordAgeInSeconds" :Integer
, "MaximumRetryAttempts" :Integer
, "ParallelizationFactor" :Integer
, "StartingPosition" :String
} }
YAML
Type: AWS::Lambda::EventSourceMapping Properties: BatchSize:
Integer
BisectBatchOnFunctionError:Boolean
DestinationConfig:DestinationConfig
Enabled:Boolean
EventSourceArn:String
FunctionName:String
MaximumBatchingWindowInSeconds:Integer
MaximumRecordAgeInSeconds:Integer
MaximumRetryAttempts:Integer
ParallelizationFactor:Integer
StartingPosition:String
Properties
BatchSize
-
The maximum number of items to retrieve in a single batch.
-
Amazon Kinesis - Default 100. Max 10,000.
-
Amazon DynamoDB Streams - Default 100. Max 1,000.
-
Amazon Simple Queue Service - Default 10. Max 10.
Required: No
Type: Integer
Minimum:
1
Maximum:
10000
Update requires: No interruption
-
BisectBatchOnFunctionError
-
(Streams) If the function returns an error, split the batch in two and retry.
Required: No
Type: Boolean
Update requires: No interruption
DestinationConfig
-
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
Required: No
Type: DestinationConfig
Update requires: No interruption
Enabled
-
Disables the event source mapping to pause polling and invocation.
Required: No
Type: Boolean
Update requires: No interruption
EventSourceArn
-
The Amazon Resource Name (ARN) of the event source.
-
Amazon Kinesis - The ARN of the data stream or a stream consumer.
-
Amazon DynamoDB Streams - The ARN of the stream.
-
Amazon Simple Queue Service - The ARN of the queue.
Required: Yes
Type: String
Pattern:
arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)
Update requires: Replacement
-
FunctionName
-
The name of the Lambda function.
Name formats
-
Function name -
MyFunction
. -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:MyFunction
. -
Version or Alias ARN -
arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
. -
Partial ARN -
123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
Required: Yes
Type: String
Minimum:
1
Maximum:
140
Pattern:
(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
Update requires: No interruption
-
MaximumBatchingWindowInSeconds
-
The maximum amount of time to gather records before invoking the function, in seconds.
Required: No
Type: Integer
Minimum:
0
Maximum:
300
Update requires: No interruption
MaximumRecordAgeInSeconds
-
(Streams) The maximum age of a record that Lambda sends to a function for processing.
Required: No
Type: Integer
Minimum:
60
Maximum:
604800
Update requires: No interruption
MaximumRetryAttempts
-
(Streams) The maximum number of times to retry when the function returns an error.
Required: No
Type: Integer
Minimum:
0
Maximum:
10000
Update requires: No interruption
ParallelizationFactor
-
(Streams) The number of batches to process from each shard concurrently.
Required: No
Type: Integer
Minimum:
1
Maximum:
10
Update requires: No interruption
StartingPosition
-
The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources.
Required: No
Type: String
Update requires: Replacement
Return Values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the mapping's ID.
For more information about using the Ref
function, see Ref.
Examples
Event Source Mapping
Create an event source mapping that reads events from Amazon Kinesis and invokes a Lambda function in the same template.
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
MyEventSourceMapping: 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"