EventSourceMappingOptions (software.amazon.awscdk:lambda 1.201.0 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:: EventSourceMappingProps

All Known Implementing Classes:: EventSourceMappingOptions.Jsii$Proxy, EventSourceMappingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-10T17:05:56.519Z")
 @Stability(value=Stable)
public interface EventSourceMappingOptions
extends software.amazon.jsii.JsiiSerializable

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.core.*;
 IEventSourceDlq eventSourceDlq;
 SourceAccessConfigurationType sourceAccessConfigurationType;
 EventSourceMappingOptions eventSourceMappingOptions = EventSourceMappingOptions.builder()
         .batchSize(123)
         .bisectBatchOnError(false)
         .enabled(false)
         .eventSourceArn("eventSourceArn")
         .kafkaBootstrapServers(List.of("kafkaBootstrapServers"))
         .kafkaTopic("kafkaTopic")
         .maxBatchingWindow(Duration.minutes(30))
         .maxRecordAge(Duration.minutes(30))
         .onFailure(eventSourceDlq)
         .parallelizationFactor(123)
         .reportBatchItemFailures(false)
         .retryAttempts(123)
         .sourceAccessConfigurations(List.of(SourceAccessConfiguration.builder()
                 .type(sourceAccessConfigurationType)
                 .uri("uri")
                 .build()))
         .startingPosition(StartingPosition.TRIM_HORIZON)
         .tumblingWindow(Duration.minutes(30))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`EventSourceMappingOptions.Builder` A builder for `EventSourceMappingOptions`
`static class`	`EventSourceMappingOptions.Jsii$Proxy` An implementation for `EventSourceMappingOptions`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static EventSourceMappingOptions.Builder`	`builder()`
`default Number`	`getBatchSize()` The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
`default Boolean`	`getBisectBatchOnError()` If the function returns an error, split the batch in two and retry.
`default Boolean`	`getEnabled()` Set to false to disable the event source upon creation.
`default String`	`getEventSourceArn()` The Amazon Resource Name (ARN) of the event source.
`default List<String>`	`getKafkaBootstrapServers()` A list of host and port pairs that are the addresses of the Kafka brokers in a self managed "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself.
`default String`	`getKafkaTopic()` The name of the Kafka topic.
`default Duration`	`getMaxBatchingWindow()` The maximum amount of time to gather records before invoking the function.
`default Duration`	`getMaxRecordAge()` The maximum age of a record that Lambda sends to a function for processing.
`default IEventSourceDlq`	`getOnFailure()` An Amazon SQS queue or Amazon SNS topic destination for discarded records.
`default Number`	`getParallelizationFactor()` The number of batches to process from each shard concurrently.
`default Boolean`	`getReportBatchItemFailures()` Allow functions to return partially successful responses for a batch of records.
`default Number`	`getRetryAttempts()` The maximum number of times to retry when the function returns an error.
`default List<SourceAccessConfiguration>`	`getSourceAccessConfigurations()` Specific settings like the authentication protocol or the VPC components to secure access to your event source.
`default StartingPosition`	`getStartingPosition()` The position in the DynamoDB, Kinesis or MSK stream where AWS Lambda should start reading.
`default Duration`	`getTumblingWindow()` The size of the tumbling windows to group records sent to DynamoDB or Kinesis.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getBatchSize
```
@Stability(value=Stable)
 @Nullable
default Number getBatchSize()
```
    The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
    Your function receives an event with all the retrieved records.
    Valid Range: Minimum value of 1. Maximum value of 10000.
    Default: - Amazon Kinesis, Amazon DynamoDB, and Amazon MSK is 100 records. The default for Amazon SQS is 10 messages. For standard SQS queues, the maximum is 10,000. For FIFO SQS queues, the maximum is 10.
  - getBisectBatchOnError
```
@Stability(value=Stable)
 @Nullable
default Boolean getBisectBatchOnError()
```
    If the function returns an error, split the batch in two and retry.
    Default: false
  - getEnabled
```
@Stability(value=Stable)
 @Nullable
default Boolean getEnabled()
```
    Set to false to disable the event source upon creation.
    Default: true
  - getEventSourceArn
```
@Stability(value=Stable)
 @Nullable
default String getEventSourceArn()
```
    The Amazon Resource Name (ARN) of the event source.
    Any record added to this stream can invoke the Lambda function.
    Default: - not set if using a self managed Kafka cluster, throws an error otherwise
  - getKafkaBootstrapServers
```
@Stability(value=Stable)
 @Nullable
default List<String> getKafkaBootstrapServers()
```
    A list of host and port pairs that are the addresses of the Kafka brokers in a self managed "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself.
    They are in the format abc.example.com:9096.
    Default: - none
  - getKafkaTopic
```
@Stability(value=Stable)
 @Nullable
default String getKafkaTopic()
```
    The name of the Kafka topic.
    Default: - no topic
  - getMaxBatchingWindow
```
@Stability(value=Stable)
 @Nullable
default Duration getMaxBatchingWindow()
```
    The maximum amount of time to gather records before invoking the function.
    Maximum of Duration.minutes(5)
    Default: Duration.seconds(0)
  - getMaxRecordAge
```
@Stability(value=Stable)
 @Nullable
default Duration getMaxRecordAge()
```
    The maximum age of a record that Lambda sends to a function for processing.
    Valid Range:
    - Minimum value of 60 seconds
    - Maximum value of 7 days
    Default: - infinite or until the record expires.
  - getOnFailure
```
@Stability(value=Stable)
 @Nullable
default IEventSourceDlq getOnFailure()
```
    An Amazon SQS queue or Amazon SNS topic destination for discarded records.
    Default: discarded records are ignored
  - getParallelizationFactor
```
@Stability(value=Stable)
 @Nullable
default Number getParallelizationFactor()
```
    The number of batches to process from each shard concurrently.
    Valid Range:
    - Minimum value of 1
    - Maximum value of 10
    Default: 1
  - getReportBatchItemFailures
```
@Stability(value=Stable)
 @Nullable
default Boolean getReportBatchItemFailures()
```
    Allow functions to return partially successful responses for a batch of records.
    Default: false
    
    See Also:
    
    https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting
  - getRetryAttempts
```
@Stability(value=Stable)
 @Nullable
default Number getRetryAttempts()
```
    The maximum number of times to retry when the function returns an error.
    Set to undefined if you want lambda to keep retrying infinitely or until the record expires.
    Valid Range:
    - Minimum value of 0
    - Maximum value of 10000
    Default: - infinite or until the record expires.
  - getSourceAccessConfigurations
```
@Stability(value=Stable)
 @Nullable
default List<SourceAccessConfiguration> getSourceAccessConfigurations()
```
    Specific settings like the authentication protocol or the VPC components to secure access to your event source.
    Default: - none
    
    See Also:
    
    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html
  - getStartingPosition
```
@Stability(value=Stable)
 @Nullable
default StartingPosition getStartingPosition()
```
    The position in the DynamoDB, Kinesis or MSK stream where AWS Lambda should start reading.
    Default: - Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources.
    
    See Also:
    
    https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType
  - getTumblingWindow
```
@Stability(value=Stable)
 @Nullable
default Duration getTumblingWindow()
```
    The size of the tumbling windows to group records sent to DynamoDB or Kinesis.
    Default: - None
    
    See Also:
    
    https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows Valid Range: 0 - 15 minutes
  - builder
```
@Stability(value=Stable)
static EventSourceMappingOptions.Builder builder()
```
    Returns:
    
    a EventSourceMappingOptions.Builder of EventSourceMappingOptions

Interface EventSourceMappingOptions

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getBatchSize

getBisectBatchOnError

getEnabled

getEventSourceArn

getKafkaBootstrapServers

getKafkaTopic

getMaxBatchingWindow

getMaxRecordAge

getOnFailure

getParallelizationFactor

getReportBatchItemFailures

getRetryAttempts

getSourceAccessConfigurations

getStartingPosition

getTumblingWindow

builder