Interface BaseStreamEventSourceProps

All Superinterfaces:
All Known Subinterfaces:
DynamoEventSourceProps, KafkaEventSourceProps, KinesisEventSourceProps, ManagedKafkaEventSourceProps, SelfManagedKafkaEventSourceProps, StreamEventSourceProps
All Known Implementing Classes:
BaseStreamEventSourceProps.Jsii$Proxy, DynamoEventSourceProps.Jsii$Proxy, KafkaEventSourceProps.Jsii$Proxy, KinesisEventSourceProps.Jsii$Proxy, ManagedKafkaEventSourceProps.Jsii$Proxy, SelfManagedKafkaEventSourceProps.Jsii$Proxy, StreamEventSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:46.822Z") @Stability(Stable) public interface BaseStreamEventSourceProps extends
The set of properties for streaming event sources shared by Dynamo, Kinesis and Kafka.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 BaseStreamEventSourceProps baseStreamEventSourceProps = BaseStreamEventSourceProps.builder()
         // the properties below are optional
  • Method Details

    • getStartingPosition

      @Stability(Stable) @NotNull StartingPosition getStartingPosition()
      Where to begin consuming the stream.
    • getBatchSize

      @Stability(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: * 1000 for DynamoEventSource * 10000 for KinesisEventSource, ManagedKafkaEventSource and SelfManagedKafkaEventSource

      Default: 100

    • getEnabled

      @Stability(Stable) @Nullable default Boolean getEnabled()
      If the stream event source mapping should be enabled.

      Default: true

    • getMaxBatchingWindow

      @Stability(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)

    • builder

      @Stability(Stable) static BaseStreamEventSourceProps.Builder builder()
      a BaseStreamEventSourceProps.Builder of BaseStreamEventSourceProps