DynamoEventSource.Builder

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

Enclosing class:: DynamoEventSource

public static final class DynamoEventSource.Builder
extends java.lang.Object

A fluent builder for DynamoEventSource.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DynamoEventSource.Builder`	`batchSize(java.lang.Number batchSize)` The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
`DynamoEventSource.Builder`	`bisectBatchOnError(java.lang.Boolean bisectBatchOnError)` If the function returns an error, split the batch in two and retry.
`DynamoEventSource`	`build()`
`static DynamoEventSource.Builder`	`create(ITable table)`
`DynamoEventSource.Builder`	`enabled(java.lang.Boolean enabled)` If the stream event source mapping should be enabled.
`DynamoEventSource.Builder`	`maxBatchingWindow(Duration maxBatchingWindow)` The maximum amount of time to gather records before invoking the function.
`DynamoEventSource.Builder`	`maxRecordAge(Duration maxRecordAge)` The maximum age of a record that Lambda sends to a function for processing.
`DynamoEventSource.Builder`	`onFailure(IEventSourceDlq onFailure)` An Amazon SQS queue or Amazon SNS topic destination for discarded records.
`DynamoEventSource.Builder`	`parallelizationFactor(java.lang.Number parallelizationFactor)` The number of batches to process from each shard concurrently.
`DynamoEventSource.Builder`	`reportBatchItemFailures(java.lang.Boolean reportBatchItemFailures)` Allow functions to return partially successful responses for a batch of records.
`DynamoEventSource.Builder`	`retryAttempts(java.lang.Number retryAttempts)` Maximum number of retry attempts Valid Range: * Minimum value of 0 * Maximum value of 10000.
`DynamoEventSource.Builder`	`startingPosition(StartingPosition startingPosition)` Where to begin consuming the stream.
`DynamoEventSource.Builder`	`tumblingWindow(Duration tumblingWindow)` 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
```
public static DynamoEventSource.Builder create(ITable table)
```
    Parameters:
    
    table - This parameter is required.
    
    Returns:
    
    a new instance of DynamoEventSource.Builder.
  - startingPosition
```
public DynamoEventSource.Builder startingPosition(StartingPosition startingPosition)
```
    Where to begin consuming the stream.
    
    Parameters:
    
    startingPosition - Where to begin consuming the stream. This parameter is required.
    
    Returns:
    
    this
  - batchSize
```
public DynamoEventSource.Builder batchSize(java.lang.Number batchSize)
```
    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}, {@link ManagedKafkaEventSource} and {@link SelfManagedKafkaEventSource}
    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
  - enabled
```
public DynamoEventSource.Builder enabled(java.lang.Boolean enabled)
```
    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
```
public DynamoEventSource.Builder maxBatchingWindow(Duration maxBatchingWindow)
```
    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
  - bisectBatchOnError
```
public DynamoEventSource.Builder bisectBatchOnError(java.lang.Boolean bisectBatchOnError)
```
    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
  - maxRecordAge
```
public DynamoEventSource.Builder maxRecordAge(Duration maxRecordAge)
```
    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
```
public DynamoEventSource.Builder onFailure(IEventSourceDlq onFailure)
```
    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
```
public DynamoEventSource.Builder parallelizationFactor(java.lang.Number parallelizationFactor)
```
    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
  - reportBatchItemFailures
```
public DynamoEventSource.Builder reportBatchItemFailures(java.lang.Boolean reportBatchItemFailures)
```
    Allow functions to return partially successful responses for a batch of records.
    Default: false
    
    Parameters:
    
    reportBatchItemFailures - Allow functions to return partially successful responses for a batch of records. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting
  - retryAttempts
```
public DynamoEventSource.Builder retryAttempts(java.lang.Number retryAttempts)
```
    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
```
public DynamoEventSource.Builder tumblingWindow(Duration tumblingWindow)
```
    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
  - build
```
public DynamoEventSource build()
```

Class DynamoEventSource.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

startingPosition

batchSize

enabled

maxBatchingWindow

bisectBatchOnError

maxRecordAge

onFailure

parallelizationFactor

reportBatchItemFailures

retryAttempts

tumblingWindow

build