AWSLambdaEventSourceMappingConfiguration

Objective-C

@interface AWSLambdaEventSourceMappingConfiguration

Swift

class AWSLambdaEventSourceMappingConfiguration

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

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

    Declaration

    Objective-C

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

    Swift

    var batchSize: NSNumber? { get set }

  • (Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

    Declaration

    Objective-C

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

    Swift

    var bisectBatchOnFunctionError: NSNumber? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var destinationConfig: AWSLambdaDestinationConfig? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var eventSourceArn: String? { get set }

  • (Streams and Amazon SQS) 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 ARN of the Lambda function.

    Declaration

    Objective-C

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

    Swift

    var functionArn: String? { get set }

  • (Streams only) 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 date that the event source mapping was last updated or that its state changed.

    Declaration

    Objective-C

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

    Swift

    var lastModified: Date? { get set }

  • The result of the last Lambda invocation of your function.

    Declaration

    Objective-C

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

    Swift

    var lastProcessingResult: String? { get set }

  • (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

    Default: 0

    Related setting: 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 }

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

    Declaration

    Objective-C

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

    Swift

    var maximumRecordAgeInSeconds: NSNumber? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var maximumRetryAttempts: NSNumber? { get set }

  • (Streams only) The number of batches to process concurrently from each shard. The default value is 1.

    Declaration

    Objective-C

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

    Swift

    var parallelizationFactor: NSNumber? { get set }

  • (Amazon 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 }

  • The self-managed Apache Kafka cluster for your event source.

    Declaration

    Objective-C

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

    Swift

    var selfManagedEventSource: AWSLambdaSelfManagedEventSource? { get set }

  • An array of the authentication protocol, VPC components, or virtual host to secure and define 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, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.

    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.

    Declaration

    Objective-C

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

    Swift

    var startingPositionTimestamp: Date? { get set }

  • The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

    Declaration

    Objective-C

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

    Swift

    var state: String? { get set }

  • Indicates whether a user or Lambda made the last change to the event source mapping.

    Declaration

    Objective-C

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

    Swift

    var stateTransitionReason: String? { get set }

  • The name of the Kafka topic.

    Declaration

    Objective-C

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

    Swift

    var topics: [String]? { get set }

  • (Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.

    Declaration

    Objective-C

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

    Swift

    var tumblingWindowInSeconds: NSNumber? { get set }

  • The identifier of the event source mapping.

    Declaration

    Objective-C

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

    Swift

    var uuid: String? { get set }