AWS Lambda Event Source Mapping
This page shows how to write Terraform and CloudFormation for Lambda Event Source Mapping and write them securely.
aws_lambda_event_source_mapping (Terraform)
The Event Source Mapping in Lambda can be configured in Terraform with the resource name aws_lambda_event_source_mapping. The following sections describe 2 examples of how to use the resource and its parameters.
Example Usage from GitHub
resource "aws_lambda_event_source_mapping" "consumer-sqs" {
event_source_arn = aws_sqs_queue.test-sqs.arn
enabled = true
function_name = aws_lambda_function.consumer-sqs.arn
batch_size = 1
}
resource "aws_lambda_event_source_mapping" "dog_processor_trigger" {
event_source_arn = aws_kinesis_stream.caught_dogs_stream.arn
function_name = "dogProcessor"
batch_size = 1
starting_position = "LATEST"
enabled = true
Parameters
-
batch_sizeoptional - number -
bisect_batch_on_function_erroroptional - bool -
enabledoptional - bool -
event_source_arnrequired - string -
function_arnoptional computed - string -
function_namerequired - string -
idoptional computed - string -
last_modifiedoptional computed - string -
last_processing_resultoptional computed - string -
maximum_batching_window_in_secondsoptional - number -
maximum_record_age_in_secondsoptional computed - number -
maximum_retry_attemptsoptional computed - number -
parallelization_factoroptional computed - number -
starting_positionoptional - string -
starting_position_timestampoptional - string -
stateoptional computed - string -
state_transition_reasonoptional computed - string -
topicsoptional - set of string -
uuidoptional computed - string -
destination_configlist block-
on_failurelist block-
destination_arnrequired - string
-
-
Explanation in Terraform Registry
Provides a Lambda event source mapping. This allows Lambda functions to get events from Kinesis, DynamoDB, SQS, Amazon MQ and Managed Streaming for Apache Kafka (MSK). For information about Lambda and how to use it, see [What is AWS Lambda?][1]. For information about event source mappings, see [CreateEventSourceMapping][2] in the API docs.
Tips: Best Practices for The Other AWS Lambda Resources
In addition to the aws_lambda_permission, AWS Lambda has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.
aws_lambda_permission
Ensure to limit your Lambda function permission as much as possible
It is better for limiting the Lambda function permission to set `source_arn` if the ARN can be specified to grant permissions.
AWS::Lambda::EventSourceMapping (CloudFormation)
The EventSourceMapping in Lambda can be configured in CloudFormation with the resource name AWS::Lambda::EventSourceMapping. The following sections describe 10 examples of how to use the resource and its parameters.
Example Usage from GitHub
Type: AWS::Lambda::EventSourceMapping
Properties:
StartingPosition: LATEST
EventSourceArn: !GetAtt StatsTable.StreamArn
FunctionName: !GetAtt TableStreamConsumerLambdaFunction.Arn
MaximumRetryAttempts: 1
Type: "AWS::Lambda::EventSourceMapping"
Properties:
BatchSize: 10
Enabled: True
EventSourceArn:
Fn::Join:
Type: AWS::Lambda::EventSourceMapping
Properties:
BatchSize: 100
Enabled: True
EventSourceArn: !GetAtt CsdRoute.StreamArn
FunctionName:
Type: AWS::Lambda::EventSourceMapping
Properties:
BatchSize: 100
Enabled: True
EventSourceArn: !GetAtt CsdRoute.StreamArn
FunctionName:
Type: AWS::Lambda::EventSourceMapping
Properties:
BatchSize: 10
Enabled: true
EventSourceArn: !GetAtt SQSPaymentResponseToTwitch.Arn
FunctionName: !GetAtt LFPaymentResponseToTwitch.Arn
"path": "/ResourceTypes/AWS::Lambda::EventSourceMapping/Properties/BatchSize/Value",
"value": {
"ValueType": "AWS::Lambda::EventSourceMapping.BatchSize"
}
},
{
"Type": "AWS::Lambda::EventSourceMapping",
"DependsOn": [
"LambdaTriggerPolicyUser",
"LambdaExecutionRole"
],
"Properties": {
"Type": "AWS::Lambda::EventSourceMapping",
"Properties": {
"MaximumBatchingWindowInSeconds": 20,
"EventSourceArn": {
"Fn::GetAtt": [
"KinesisStream",
"Type": "AWS::Lambda::EventSourceMapping",
"Properties": {
"MaximumBatchingWindowInSeconds": 20,
"EventSourceArn": {
"Fn::GetAtt": [
"KinesisStream",
"Type": "AWS::Lambda::EventSourceMapping",
"Properties": {
"MaximumBatchingWindowInSeconds": 20,
"EventSourceArn": {
"Fn::GetAtt": [
"KinesisStream",
Parameters
-
BatchSizeoptional - Integer -
BisectBatchOnFunctionErroroptional - Boolean -
DestinationConfigoptional - DestinationConfig -
Enabledoptional - Boolean -
EventSourceArnoptional - String -
FunctionNamerequired - String -
MaximumBatchingWindowInSecondsoptional - Integer -
MaximumRecordAgeInSecondsoptional - Integer -
MaximumRetryAttemptsoptional - Integer -
ParallelizationFactoroptional - Integer -
StartingPositionoptional - String -
StartingPositionTimestampoptional - Double -
Topicsoptional - List -
Queuesoptional - List -
SourceAccessConfigurationsoptional - List of SourceAccessConfiguration -
TumblingWindowInSecondsoptional - Integer -
FunctionResponseTypesoptional - List -
SelfManagedEventSourceoptional - SelfManagedEventSource
Explanation in CloudFormation Registry
The
AWS::Lambda::EventSourceMappingresource 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. In particular, each of the topics describes the required and optional parameters for the specific event source.
Frequently asked questions
What is AWS Lambda Event Source Mapping?
AWS Lambda Event Source Mapping is a resource for Lambda of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.
Where can I find the example code for the AWS Lambda Event Source Mapping?
For Terraform, the tochukaso/terraform and rodrigogregorioneri/localstack_terraform source code examples are useful. See the Terraform Example section for further details.
For CloudFormation, the broswen/StatsStream, mozilla-iam/cis_functions and mmanoj880/DevOps source code examples are useful. See the CloudFormation Example section for further details.
