CreateEventSourceMappingRequest Class

Container for the parameters to the CreateEventSourceMapping operation. Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function.

For details about how to configure different event sources, see the following topics.

The following error handling options are available only for stream sources (DynamoDB and Kinesis):

BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.
DestinationConfig – Send discarded records to an Amazon SQS queue or Amazon SNS topic.
MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
ParallelizationFactor – Process multiple batches from each shard concurrently.

For information about which configuration parameters apply to each event source, see the following topics.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Lambda.AmazonLambdaRequest
      Amazon.Lambda.Model.CreateEventSourceMappingRequest

Namespace: Amazon.Lambda.Model
Assembly: AWSSDK.Lambda.dll
Version: 3.x.y.z

Syntax

public class CreateEventSourceMappingRequest : AmazonLambdaRequest
         IAmazonWebServiceRequest

The CreateEventSourceMappingRequest type exposes the following members

Constructors

	Name	Description
	CreateEventSourceMappingRequest()

Properties

Name	Type	Description
AmazonManagedKafkaEventSourceConfig	Amazon.Lambda.Model.AmazonManagedKafkaEventSourceConfig	Gets and sets the property AmazonManagedKafkaEventSourceConfig. Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
BatchSize	System.Int32	Gets and sets the property 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. DocumentDB – Default 100. Max 10,000.
BisectBatchOnFunctionError	System.Boolean	Gets and sets the property BisectBatchOnFunctionError. (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
DestinationConfig	Amazon.Lambda.Model.DestinationConfig	Gets and sets the property DestinationConfig. (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.
DocumentDBEventSourceConfig	Amazon.Lambda.Model.DocumentDBEventSourceConfig	Gets and sets the property DocumentDBEventSourceConfig. Specific configuration settings for a DocumentDB event source.
Enabled	System.Boolean	Gets and sets the property Enabled. When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True
EventSourceArn	System.String	Gets and sets the property 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 or the ARN of the VPC connection (for cross-account event source mappings). Amazon MQ – The ARN of the broker. Amazon DocumentDB – The ARN of the DocumentDB change stream.
FilterCriteria	Amazon.Lambda.Model.FilterCriteria	Gets and sets the property FilterCriteria. An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
FunctionName	System.String	Gets and sets the property FunctionName. The name or ARN 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.
FunctionResponseTypes	System.Collections.Generic.List<System.String>	Gets and sets the property FunctionResponseTypes. (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
MaximumBatchingWindowInSeconds	System.Int32	Gets and sets the property MaximumBatchingWindowInSeconds. The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure `MaximumBatchingWindowInSeconds` to any value from 0 seconds to 300 seconds in increments of seconds. For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change `MaximumBatchingWindowInSeconds` in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping. Related setting: For streams and Amazon SQS event sources, when you set `BatchSize` to a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1.
MaximumRecordAgeInSeconds	System.Int32	Gets and sets the property MaximumRecordAgeInSeconds. (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).
MaximumRetryAttempts	System.Int32	Gets and sets the property MaximumRetryAttempts. (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
ParallelizationFactor	System.Int32	Gets and sets the property ParallelizationFactor. (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
Queues	System.Collections.Generic.List<System.String>	Gets and sets the property Queues. (MQ) The name of the Amazon MQ broker destination queue to consume.
ScalingConfig	Amazon.Lambda.Model.ScalingConfig	Gets and sets the property ScalingConfig. (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
SelfManagedEventSource	Amazon.Lambda.Model.SelfManagedEventSource	Gets and sets the property SelfManagedEventSource. The self-managed Apache Kafka cluster to receive records from.
SelfManagedKafkaEventSourceConfig	Amazon.Lambda.Model.SelfManagedKafkaEventSourceConfig	Gets and sets the property SelfManagedKafkaEventSourceConfig. Specific configuration settings for a self-managed Apache Kafka event source.
SourceAccessConfigurations	System.Collections.Generic.List<Amazon.Lambda.Model.SourceAccessConfiguration>	Gets and sets the property SourceAccessConfigurations. An array of authentication protocols or VPC components required to secure your event source.
StartingPosition	Amazon.Lambda.EventSourcePosition	Gets and sets the property StartingPosition. The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. `AT_TIMESTAMP` is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.
StartingPositionTimestamp	System.DateTime	Gets and sets the property StartingPositionTimestamp. With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading. `StartingPositionTimestamp` cannot be in the future.
Topics	System.Collections.Generic.List<System.String>	Gets and sets the property Topics. The name of the Kafka topic.
TumblingWindowInSeconds	System.Int32	Gets and sets the property TumblingWindowInSeconds. (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.

Examples

The following example creates a mapping between an SQS queue and the my-function Lambda function.

To create a mapping between an event source and an AWS Lambda function


var response = client.CreateEventSourceMapping(new CreateEventSourceMappingRequest 
{
    BatchSize = 5,
    EventSourceArn = "arn:aws:sqs:us-west-2:123456789012:my-queue",
    FunctionName = "my-function"
});

int batchSize = response.BatchSize;
string eventSourceArn = response.EventSourceArn;
string functionArn = response.FunctionArn;
DateTime lastModified = response.LastModified;
string state = response.State;
string stateTransitionReason = response.StateTransitionReason;
string uuid = response.UUID;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5