CreateEventSourceMappingResponse Class

A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.

Inheritance Hierarchy

System.Object
Amazon.Runtime.AmazonWebServiceResponse
Amazon.Lambda.Model.CreateEventSourceMappingResponse

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

Syntax

public class CreateEventSourceMappingResponse : AmazonWebServiceResponse

The CreateEventSourceMappingResponse type exposes the following members

Constructors

	Name	Description
	CreateEventSourceMappingResponse()

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). Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100. Related setting: When you set `BatchSize` to a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1.
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. The default value is false.
ContentLength	System.Int64	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
DestinationConfig	Amazon.Lambda.Model.DestinationConfig	Gets and sets the property DestinationConfig. (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.
DocumentDBEventSourceConfig	Amazon.Lambda.Model.DocumentDBEventSourceConfig	Gets and sets the property DocumentDBEventSourceConfig. Specific configuration settings for a DocumentDB event source.
EventSourceArn	System.String	Gets and sets the property EventSourceArn. The Amazon Resource Name (ARN) of the event source.
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.
FunctionArn	System.String	Gets and sets the property FunctionArn. The ARN of the Lambda function.
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.
HttpStatusCode	System.Net.HttpStatusCode	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
LastModified	System.DateTime	Gets and sets the property LastModified. The date that the event source mapping was last updated or that its state changed.
LastProcessingResult	System.String	Gets and sets the property LastProcessingResult. The result of the last Lambda invocation of your function.
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 -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
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 -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.
ParallelizationFactor	System.Int32	Gets and sets the property ParallelizationFactor. (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
Queues	System.Collections.Generic.List<System.String>	Gets and sets the property Queues. (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
ResponseMetadata	Amazon.Runtime.ResponseMetadata	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
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 for your event source.
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 the authentication protocol, VPC components, or virtual host to secure and define 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.
State	System.String	Gets and sets the property State. The state of the event source mapping. It can be one of the following: `Creating`, `Enabling`, `Enabled`, `Disabling`, `Disabled`, `Updating`, or `Deleting`.
StateTransitionReason	System.String	Gets and sets the property StateTransitionReason. Indicates whether a user or Lambda made the last change to the event source mapping.
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.
UUID	System.String	Gets and sets the property UUID. The identifier of the event source mapping.

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