AWSLambdaCreateEventSourceMappingRequest

Objective-C

@interface AWSLambdaCreateEventSourceMappingRequest

Swift

class AWSLambdaCreateEventSourceMappingRequest

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSLambdaAmazonManagedKafkaEventSourceConfig *_Nullable amazonManagedKafkaEventSourceConfig;

    Swift

    var amazonManagedKafkaEventSourceConfig: AWSLambdaAmazonManagedKafkaEventSourceConfig? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable batchSize;

    Swift

    var batchSize: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable bisectBatchOnFunctionError;

    Swift

    var bisectBatchOnFunctionError: NSNumber? { get set }

  • (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSLambdaDestinationConfig *_Nullable destinationConfig;

    Swift

    var destinationConfig: AWSLambdaDestinationConfig? { get set }

  • Specific configuration settings for a DocumentDB event source.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSLambdaDocumentDBEventSourceConfig *_Nullable documentDBEventSourceConfig;

    Swift

    var documentDBEventSourceConfig: AWSLambdaDocumentDBEventSourceConfig? { get set }

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

    Default: True

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable enabled;

    Swift

    var enabled: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable eventSourceArn;

    Swift

    var eventSourceArn: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSLambdaFilterCriteria *_Nullable filterCriteria;

    Swift

    var filterCriteria: AWSLambdaFilterCriteria? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable functionName;

    Swift

    var functionName: String? { get set }

  • (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable functionResponseTypes;

    Swift

    var functionResponseTypes: [String]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable maximumBatchingWindowInSeconds;

    Swift

    var maximumBatchingWindowInSeconds: NSNumber? { get set }

  • (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable maximumRecordAgeInSeconds;

    Swift

    var maximumRecordAgeInSeconds: NSNumber? { get set }

  • (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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable maximumRetryAttempts;

    Swift

    var maximumRetryAttempts: NSNumber? { get set }

  • (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable parallelizationFactor;

    Swift

    var parallelizationFactor: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable queues;

    Swift

    var queues: [String]? { get set }

  • (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSLambdaScalingConfig *_Nullable scalingConfig;

    Swift

    var scalingConfig: AWSLambdaScalingConfig? { get set }

  • The self-managed Apache Kafka cluster to receive records from.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSLambdaSelfManagedEventSource *_Nullable selfManagedEventSource;

    Swift

    var selfManagedEventSource: AWSLambdaSelfManagedEventSource? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSLambdaSelfManagedKafkaEventSourceConfig *_Nullable selfManagedKafkaEventSourceConfig;

    Swift

    var selfManagedKafkaEventSourceConfig: AWSLambdaSelfManagedKafkaEventSourceConfig? { get set }

  • An array of authentication protocols or VPC components required to secure your event source.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSLambdaSourceAccessConfiguration *> *_Nullable sourceAccessConfigurations;

    Swift

    var sourceAccessConfigurations: [AWSLambdaSourceAccessConfiguration]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSLambdaEventSourcePosition startingPosition;

    Swift

    var startingPosition: AWSLambdaEventSourcePosition { get set }

  • With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable startingPositionTimestamp;

    Swift

    var startingPositionTimestamp: Date? { get set }

  • The name of the Kafka topic.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable topics;

    Swift

    var topics: [String]? { get set }

  • (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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable tumblingWindowInSeconds;

    Swift

    var tumblingWindowInSeconds: NSNumber? { get set }