Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-lambda-eventsourcemapping.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::Lambda::EventSourceMapping. Source:- No source definition found, add manually please

Properties

FunctionName string | Aws_CF_FunctionString required

The name of the Lambda function.

BatchSize integer

The maximum number of items to retrieve in a single batch.

min=1max=10000
BisectBatchOnFunctionError boolean

(Streams) If the function returns an error, split the batch in two and retry.

DestinationConfig object

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

1 nested properties
OnFailure object

A destination for events that failed processing.

1 nested properties
Destination string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the destination resource.

Enabled boolean

Disables the event source mapping to pause polling and invocation.

EventSourceArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the event source.

FilterCriteria object

The filter criteria to control event filtering.

1 nested properties
Filters Filter[]

List of filters of this FilterCriteria

minItems=1maxItems=20uniqueItems=true
MaximumBatchingWindowInSeconds integer

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

min=0max=300
MaximumRecordAgeInSeconds integer

(Streams) The maximum age of a record that Lambda sends to a function for processing.

min=-1max=604800
MaximumRetryAttempts integer

(Streams) The maximum number of times to retry when the function returns an error.

min=-1max=10000
ParallelizationFactor integer

(Streams) The number of batches to process from each shard concurrently.

min=1max=10
StartingPosition string | Aws_CF_FunctionString

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

StartingPositionTimestamp number

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

Topics string[]

(Kafka) A list of Kafka topics.

minItems=1maxItems=1uniqueItems=true
Queues string[]

(ActiveMQ) A list of ActiveMQ queues.

minItems=1maxItems=1uniqueItems=true
SourceAccessConfigurations SourceAccessConfiguration[]

A list of SourceAccessConfiguration.

minItems=1maxItems=22uniqueItems=true
TumblingWindowInSeconds integer

(Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.

min=0max=900
FunctionResponseTypes string[]

(Streams) A list of response types supported by the function.

minLength=0maxLength=1uniqueItems=true
SelfManagedEventSource object

The configuration used by AWS Lambda to access a self-managed event source.

1 nested properties
Endpoints object

The endpoints used by AWS Lambda to access a self-managed event source.

1 nested properties
KafkaBootstrapServers string[]

A list of Kafka server endpoints.

minItems=1maxItems=10uniqueItems=true
AmazonManagedKafkaEventSourceConfig object

Specific configuration settings for an MSK event source.

1 nested properties
ConsumerGroupId string | Aws_CF_FunctionString

The identifier for the Kafka Consumer Group to join.

SelfManagedKafkaEventSourceConfig object

Specific configuration settings for a Self-Managed Apache Kafka event source.

1 nested properties
ConsumerGroupId string | Aws_CF_FunctionString

The identifier for the Kafka Consumer Group to join.

ScalingConfig object

The scaling configuration for the event source.

1 nested properties
MaximumConcurrency integer

The maximum number of concurrent functions that an event source can invoke.

min=2max=1000
DocumentDBEventSourceConfig object

Document db event source config.

3 nested properties
DatabaseName string | Aws_CF_FunctionString

The database name to connect to.

CollectionName string | Aws_CF_FunctionString

The collection name to connect to.

FullDocument string | Aws_CF_FunctionString

Include full document in change stream response. The default option will only send the changes made to documents to Lambda. If you want the complete document sent to Lambda, set this to UpdateLookup.

Definitions

DestinationConfig object

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

OnFailure object

A destination for events that failed processing.

1 nested properties
Destination string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the destination resource.

FilterCriteria object

The filter criteria to control event filtering.

Filters Filter[]

List of filters of this FilterCriteria

minItems=1maxItems=20uniqueItems=true
Filter object

The filter object that defines parameters for ESM filtering.

Pattern string | Aws_CF_FunctionString

The filter pattern that defines which events should be passed for invocations.

OnFailure object

A destination for events that failed processing.

Destination string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the destination resource.

SourceAccessConfiguration object

The configuration used by AWS Lambda to access event source

Type string | Aws_CF_FunctionString

The type of source access configuration.

URI string | Aws_CF_FunctionString

The URI for the source access configuration resource.

SelfManagedEventSource object

The configuration used by AWS Lambda to access a self-managed event source.

Endpoints object

The endpoints used by AWS Lambda to access a self-managed event source.

1 nested properties
KafkaBootstrapServers string[]

A list of Kafka server endpoints.

minItems=1maxItems=10uniqueItems=true
Endpoints object

The endpoints used by AWS Lambda to access a self-managed event source.

KafkaBootstrapServers string[]

A list of Kafka server endpoints.

minItems=1maxItems=10uniqueItems=true
ConsumerGroupId string | Aws_CF_FunctionString

The identifier for the Kafka Consumer Group to join.

AmazonManagedKafkaEventSourceConfig object

Specific configuration settings for an MSK event source.

ConsumerGroupId string | Aws_CF_FunctionString

The identifier for the Kafka Consumer Group to join.

SelfManagedKafkaEventSourceConfig object

Specific configuration settings for a Self-Managed Apache Kafka event source.

ConsumerGroupId string | Aws_CF_FunctionString

The identifier for the Kafka Consumer Group to join.

MaximumConcurrency integer

The maximum number of concurrent functions that an event source can invoke.

ScalingConfig object

The scaling configuration for the event source.

MaximumConcurrency integer

The maximum number of concurrent functions that an event source can invoke.

min=2max=1000
DocumentDBEventSourceConfig object

Document db event source config.

DatabaseName string | Aws_CF_FunctionString

The database name to connect to.

CollectionName string | Aws_CF_FunctionString

The collection name to connect to.

FullDocument string | Aws_CF_FunctionString

Include full document in change stream response. The default option will only send the changes made to documents to Lambda. If you want the complete document sent to Lambda, set this to UpdateLookup.