AWS::Lambda::EventSourceMapping - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

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. In particular, each of the topics describes the required and optional parameters for the specific event source.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

Properties

AmazonManagedKafkaEventSourceConfig

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

Required: No

Type: AmazonManagedKafkaEventSourceConfig

Update requires: Replacement

BatchSize

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

  • Amazon Kinesis - Default 100. Max 10,000.

  • Amazon DynamoDB Streams - Default 100. Max 10,000.

  • Amazon Simple Queue Service - Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

  • Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.

  • Self-managed Apache Kafka - Default 100. Max 10,000.

  • Amazon MQ (ActiveMQ and RabbitMQ) - Default 100. Max 10,000.

Required: No

Type: Integer

Minimum: 1

Maximum: 10000

Update requires: No interruption

BisectBatchOnFunctionError

(Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

Required: No

Type: Boolean

Update requires: No interruption

DestinationConfig

(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

Required: No

Type: DestinationConfig

Update requires: No interruption

Enabled

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

Default: True

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.

  • Amazon Managed Streaming for Apache Kafka - The ARN of the cluster.

  • Amazon MQ - The ARN of the broker.

Required: No

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

FilterCriteria

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

Required: No

Type: FilterCriteria

Update requires: No interruption

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

FunctionResponseTypes

(Streams and SQS) A list of current response type enums applied to the event source mapping.

Valid Values: ReportBatchItemFailures

Required: No

Type: List of String

Maximum: 1

Update requires: No interruption

MaximumBatchingWindowInSeconds

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

Default (Kinesis, DynamoDB, Amazon SQS event sources): 0

Default (Amazon MSK, Kafka, Amazon MQ event sources): 500 ms

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

Required: No

Type: Integer

Minimum: 0

Maximum: 300

Update requires: No interruption

MaximumRecordAgeInSeconds

(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

Required: No

Type: Integer

Minimum: -1

Maximum: 604800

Update requires: No interruption

MaximumRetryAttempts

(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

Required: No

Type: Integer

Minimum: -1

Maximum: 10000

Update requires: No interruption

ParallelizationFactor

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

Required: No

Type: Integer

Minimum: 1

Maximum: 10

Update requires: No interruption

Queues

(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

Required: No

Type: List of String

Maximum: 1

Update requires: No interruption

SelfManagedEventSource

The self-managed Apache Kafka cluster for your event source.

Required: No

Type: SelfManagedEventSource

Update requires: Replacement

SelfManagedKafkaEventSourceConfig

Specific configuration settings for a self-managed Apache Kafka event source.

Required: No

Type: SelfManagedKafkaEventSourceConfig

Update requires: Replacement

SourceAccessConfigurations

An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

Required: No

Type: List of SourceAccessConfiguration

Maximum: 22

Update requires: No interruption

StartingPosition

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.

  • LATEST - Read only new records.

  • TRIM_HORIZON - Process all available records.

  • AT_TIMESTAMP - Specify a time from which to start reading records.

Required: No

Type: String

Update requires: Replacement

StartingPositionTimestamp

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.

Required: No

Type: Double

Update requires: Replacement

Topics

The name of the Kafka topic.

Required: No

Type: List of String

Maximum: 1

Update requires: No interruption

TumblingWindowInSeconds

(Streams only) The duration in seconds of a processing window. The range is between 1 second and 900 seconds.

Required: No

Type: Integer

Minimum: 0

Maximum: 900

Update requires: No interruption

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.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Id

The event source mapping's ID.

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"