Skip to content

Latest commit

 

History

History
145 lines (119 loc) · 7.95 KB

API_EventSourceMappingConfiguration.md

File metadata and controls

145 lines (119 loc) · 7.95 KB
Raw

EventSourceMappingConfiguration

A mapping between an AWS resource and a Lambda function. For details, see CreateEventSourceMapping .

Contents

** 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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.
Required: No

** BisectBatchOnFunctionError ** (Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
Type: Boolean
Required: No

** DestinationConfig ** (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
Type: DestinationConfig object
Required: No

** EventSourceArn ** The Amazon Resource Name (ARN) of the event source.
Type: String
Pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)
Required: No

** FunctionArn ** The ARN of the Lambda function.
Type: String
Pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
Required: No

** FunctionResponseTypes ** (Streams only) A list of current response type enums applied to the event source mapping.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Valid Values: ReportBatchItemFailures
Required: No

** LastModified ** The date that the event source mapping was last updated or that its state changed, in Unix time seconds.
Type: Timestamp
Required: No

** LastProcessingResult ** The result of the last Lambda invocation of your function.
Type: String
Required: No

** MaximumBatchingWindowInSeconds ** (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.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 300.
Required: No

** MaximumRecordAgeInSeconds ** (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.
Type: Integer
Valid Range: Minimum value of -1. Maximum value of 604800.
Required: No

** MaximumRetryAttempts ** (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.
Type: Integer
Valid Range: Minimum value of -1. Maximum value of 10000.
Required: No

** ParallelizationFactor ** (Streams only) The number of batches to process concurrently from each shard. The default value is 1.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No

** Queues ** (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: [\s\S]*
Required: No

** SelfManagedEventSource ** The self-managed Apache Kafka cluster for your event source.
Type: SelfManagedEventSource object
Required: No

** SourceAccessConfigurations ** An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
Type: Array of SourceAccessConfiguration objects
Array Members: Minimum number of 0 items. Maximum number of 22 items.
Required: No

** StartingPosition ** 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.
Type: String
Valid Values: TRIM_HORIZON | LATEST | AT_TIMESTAMP
Required: No

** StartingPositionTimestamp ** With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
Type: Timestamp
Required: No

** State ** The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.
Type: String
Required: No

** StateTransitionReason ** Indicates whether a user or Lambda made the last change to the event source mapping.
Type: String
Required: No

** Topics ** The name of the Kafka topic.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 249.
Pattern: ^[^.]([a-zA-Z0-9\-_.]+)
Required: No

** TumblingWindowInSeconds ** (Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 900.
Required: No

** UUID ** The identifier of the event source mapping.
Type: String
Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: