ManagedKafkaEventSource.Builder (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.10 API)

java.lang.Object
- software.amazon.awscdk.services.lambda.eventsources.ManagedKafkaEventSource.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ManagedKafkaEventSource>

Enclosing class:

ManagedKafkaEventSource
```
@Stability(value=Experimental)
public static final class ManagedKafkaEventSource.Builder
extends Object
implements software.amazon.jsii.Builder<ManagedKafkaEventSource>
```
(experimental) A fluent builder for ManagedKafkaEventSource.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ManagedKafkaEventSource.Builder`	`batchSize(Number batchSize)` (experimental) The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
`ManagedKafkaEventSource.Builder`	`bisectBatchOnError(Boolean bisectBatchOnError)` (experimental) If the function returns an error, split the batch in two and retry.
`ManagedKafkaEventSource`	`build()`
`ManagedKafkaEventSource.Builder`	`clusterArn(String clusterArn)` (experimental) an MSK cluster construct.
`static ManagedKafkaEventSource.Builder`	`create()`
`ManagedKafkaEventSource.Builder`	`enabled(Boolean enabled)` (experimental) If the stream event source mapping should be enabled.
`ManagedKafkaEventSource.Builder`	`maxBatchingWindow(Duration maxBatchingWindow)` (experimental) The maximum amount of time to gather records before invoking the function.
`ManagedKafkaEventSource.Builder`	`maxRecordAge(Duration maxRecordAge)` (experimental) The maximum age of a record that Lambda sends to a function for processing.
`ManagedKafkaEventSource.Builder`	`onFailure(IEventSourceDlq onFailure)` (experimental) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
`ManagedKafkaEventSource.Builder`	`parallelizationFactor(Number parallelizationFactor)` (experimental) The number of batches to process from each shard concurrently.
`ManagedKafkaEventSource.Builder`	`retryAttempts(Number retryAttempts)` (experimental) Maximum number of retry attempts Valid Range: * Minimum value of 0 * Maximum value of 10000.
`ManagedKafkaEventSource.Builder`	`secret(ISecret secret)` (experimental) the secret with the Kafka credentials, see https://docs.aws.amazon.com/msk/latest/developerguide/msk-password.html for details.
`ManagedKafkaEventSource.Builder`	`startingPosition(StartingPosition startingPosition)` (experimental) Where to begin consuming the stream.
`ManagedKafkaEventSource.Builder`	`topic(String topic)` (experimental) the Kafka topic to subscribe to.
`ManagedKafkaEventSource.Builder`	`tumblingWindow(Duration tumblingWindow)` (experimental) The size of the tumbling windows to group records sent to DynamoDB or Kinesis Valid Range: 0 - 15 minutes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
@Stability(value=Experimental)
public static ManagedKafkaEventSource.Builder create()
```
    Returns:
    
    a new instance of ManagedKafkaEventSource.Builder.
  - startingPosition
```
@Stability(value=Experimental)
public ManagedKafkaEventSource.Builder startingPosition(StartingPosition startingPosition)
```
    (experimental) Where to begin consuming the stream.
    
    Parameters:
    
    startingPosition - Where to begin consuming the stream. This parameter is required.
    
    Returns:
    
    this
  - batchSize
```
@Stability(value=Experimental)
public ManagedKafkaEventSource.Builder batchSize(Number batchSize)
```
    (experimental) 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 {@link DynamoEventSource}
      
      10000 for {@link KinesisEventSource}
    Default: 100
    Parameters:
    
    batchSize - The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. This parameter is required.
    
    Returns:
    
    this
  - bisectBatchOnError
```
@Stability(value=Experimental)
public ManagedKafkaEventSource.Builder bisectBatchOnError(Boolean bisectBatchOnError)
```
    (experimental) If the function returns an error, split the batch in two and retry.
    Default: false
    
    Parameters:
    
    bisectBatchOnError - If the function returns an error, split the batch in two and retry. This parameter is required.
    
    Returns:
    
    this
  - enabled
```
@Stability(value=Experimental)
public ManagedKafkaEventSource.Builder enabled(Boolean enabled)
```
    (experimental) If the stream event source mapping should be enabled.
    Default: true
    
    Parameters:
    
    enabled - If the stream event source mapping should be enabled. This parameter is required.
    
    Returns:
    
    this
  - maxBatchingWindow
```
@Stability(value=Experimental)
public ManagedKafkaEventSource.Builder maxBatchingWindow(Duration maxBatchingWindow)
```
    (experimental) The maximum amount of time to gather records before invoking the function.
    Maximum of Duration.minutes(5)
    Default: Duration.seconds(0)
    
    Parameters:
    
    maxBatchingWindow - The maximum amount of time to gather records before invoking the function. This parameter is required.
    
    Returns:
    
    this
  - maxRecordAge
```
@Stability(value=Experimental)
public ManagedKafkaEventSource.Builder maxRecordAge(Duration maxRecordAge)
```
    (experimental) 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: - the retention period configured on the stream
    Parameters:
    
    maxRecordAge - The maximum age of a record that Lambda sends to a function for processing. This parameter is required.
    
    Returns:
    
    this
  - onFailure
```
@Stability(value=Experimental)
public ManagedKafkaEventSource.Builder onFailure(IEventSourceDlq onFailure)
```
    (experimental) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
    Default: discarded records are ignored
    
    Parameters:
    
    onFailure - An Amazon SQS queue or Amazon SNS topic destination for discarded records. This parameter is required.
    
    Returns:
    
    this
  - parallelizationFactor
```
@Stability(value=Experimental)
public ManagedKafkaEventSource.Builder parallelizationFactor(Number parallelizationFactor)
```
    (experimental) The number of batches to process from each shard concurrently.
    Valid Range:
    - Minimum value of 1
    - Maximum value of 10
    Default: 1
    Parameters:
    
    parallelizationFactor - The number of batches to process from each shard concurrently. This parameter is required.
    
    Returns:
    
    this
  - retryAttempts
```
@Stability(value=Experimental)
public ManagedKafkaEventSource.Builder retryAttempts(Number retryAttempts)
```
    (experimental) Maximum number of retry attempts Valid Range: * Minimum value of 0 * Maximum value of 10000.
    Default: - retry until the record expires
    
    Parameters:
    
    retryAttempts - Maximum number of retry attempts Valid Range: * Minimum value of 0 * Maximum value of 10000. This parameter is required.
    
    Returns:
    
    this
  - tumblingWindow
```
@Stability(value=Experimental)
public ManagedKafkaEventSource.Builder tumblingWindow(Duration tumblingWindow)
```
    (experimental) The size of the tumbling windows to group records sent to DynamoDB or Kinesis Valid Range: 0 - 15 minutes.
    Default: - None
    
    Parameters:
    
    tumblingWindow - The size of the tumbling windows to group records sent to DynamoDB or Kinesis Valid Range: 0 - 15 minutes. This parameter is required.
    
    Returns:
    
    this
  - secret
```
@Stability(value=Experimental)
public ManagedKafkaEventSource.Builder secret(ISecret secret)
```
    (experimental) the secret with the Kafka credentials, see https://docs.aws.amazon.com/msk/latest/developerguide/msk-password.html for details.
    
    Parameters:
    
    secret - the secret with the Kafka credentials, see https://docs.aws.amazon.com/msk/latest/developerguide/msk-password.html for details. This parameter is required.
    
    Returns:
    
    this
  - topic
```
@Stability(value=Experimental)
public ManagedKafkaEventSource.Builder topic(String topic)
```
    (experimental) the Kafka topic to subscribe to.
    
    Parameters:
    
    topic - the Kafka topic to subscribe to. This parameter is required.
    
    Returns:
    
    this
  - clusterArn
```
@Stability(value=Experimental)
public ManagedKafkaEventSource.Builder clusterArn(String clusterArn)
```
    (experimental) an MSK cluster construct.
    
    Parameters:
    
    clusterArn - an MSK cluster construct. This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(value=Experimental)
public ManagedKafkaEventSource build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<ManagedKafkaEventSource>

Class ManagedKafkaEventSource.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

startingPosition

batchSize

bisectBatchOnError

enabled

maxBatchingWindow

maxRecordAge

onFailure

parallelizationFactor

retryAttempts

tumblingWindow

secret

topic

clusterArn

build