Event Source Mapping Args
The `AWS::Lambda::EventSourceMapping`
resource creates a mapping between an event source and an LAMlong function. LAM 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.
Constructors
Properties
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
Specific configuration settings for a DocumentDB event source.
The Amazon Resource Name (ARN) of the event source.
An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
The name or ARN of the Lambda function. Name formats
(Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping. Valid Values: `ReportBatchItemFailures`
The ARN of the KMSlong (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. Default (, , event sources): 0 Default (, Kafka, , event sources): 500 ms Related setting: For SQS event sources, when you set `BatchSize`
to a value greater than 10, you must set `MaximumBatchingWindowInSeconds`
to at least 1.
(Kinesis and DynamoDB 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. The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
(Kinesis and DynamoDB 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.
(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
The self-managed Apache Kafka cluster for your event source.
Specific configuration settings for a self-managed Apache Kafka event source.
An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.
With `StartingPosition`
set to `AT_TIMESTAMP`
, the time from which to start reading, in Unix time seconds. `StartingPositionTimestamp`
cannot be in the future.
(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.