Package software.amazon.awscdk.services.lambda.eventsources

Class KinesisEventSourceProps.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.eventsources.KinesisEventSourceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<KinesisEventSourceProps>

Enclosing interface:

KinesisEventSourceProps

@Stability(Stable)
public static final class KinesisEventSourceProps.Builder
extends Object
implements software.amazon.jsii.Builder<KinesisEventSourceProps>

A builder for KinesisEventSourceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KinesisEventSourceProps.Builder	batchSize(Number batchSize)	Sets the value of BaseStreamEventSourceProps.getBatchSize()
KinesisEventSourceProps.Builder	bisectBatchOnError(Boolean bisectBatchOnError)	Sets the value of StreamEventSourceProps.getBisectBatchOnError()
KinesisEventSourceProps	build()	Builds the configured instance.
KinesisEventSourceProps.Builder	enabled(Boolean enabled)	Sets the value of BaseStreamEventSourceProps.getEnabled()
KinesisEventSourceProps.Builder	filterEncryption(IKey filterEncryption)	Sets the value of StreamEventSourceProps.getFilterEncryption()
KinesisEventSourceProps.Builder	filters(List<? extends Map<String,? extends Object>> filters)	Sets the value of StreamEventSourceProps.getFilters()
KinesisEventSourceProps.Builder	maxBatchingWindow(Duration maxBatchingWindow)	Sets the value of BaseStreamEventSourceProps.getMaxBatchingWindow()
KinesisEventSourceProps.Builder	maxRecordAge(Duration maxRecordAge)	Sets the value of StreamEventSourceProps.getMaxRecordAge()
KinesisEventSourceProps.Builder	metricsConfig(MetricsConfig metricsConfig)	Sets the value of StreamEventSourceProps.getMetricsConfig()
KinesisEventSourceProps.Builder	onFailure(IEventSourceDlq onFailure)	Sets the value of StreamEventSourceProps.getOnFailure()
KinesisEventSourceProps.Builder	parallelizationFactor(Number parallelizationFactor)	Sets the value of StreamEventSourceProps.getParallelizationFactor()
KinesisEventSourceProps.Builder	provisionedPollerConfig(ProvisionedPollerConfig provisionedPollerConfig)	Sets the value of BaseStreamEventSourceProps.getProvisionedPollerConfig()
KinesisEventSourceProps.Builder	reportBatchItemFailures(Boolean reportBatchItemFailures)	Sets the value of StreamEventSourceProps.getReportBatchItemFailures()
KinesisEventSourceProps.Builder	retryAttempts(Number retryAttempts)	Sets the value of StreamEventSourceProps.getRetryAttempts()
KinesisEventSourceProps.Builder	startingPosition(StartingPosition startingPosition)	Sets the value of BaseStreamEventSourceProps.getStartingPosition()
KinesisEventSourceProps.Builder	startingPositionTimestamp(Number startingPositionTimestamp)	Sets the value of KinesisEventSourceProps.getStartingPositionTimestamp()
KinesisEventSourceProps.Builder	tumblingWindow(Duration tumblingWindow)	Sets the value of StreamEventSourceProps.getTumblingWindow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

startingPositionTimestamp

@Stability(Stable)
public KinesisEventSourceProps.Builder startingPositionTimestamp(Number startingPositionTimestamp)

Sets the value of KinesisEventSourceProps.getStartingPositionTimestamp()

Parameters:

startingPositionTimestamp - The time from which to start reading, in Unix time seconds.

Returns:

this

bisectBatchOnError

@Stability(Stable)
public KinesisEventSourceProps.Builder bisectBatchOnError(Boolean bisectBatchOnError)

Sets the value of StreamEventSourceProps.getBisectBatchOnError()

Parameters:

bisectBatchOnError - If the function returns an error, split the batch in two and retry.

Returns:

this

filterEncryption

@Stability(Stable)
public KinesisEventSourceProps.Builder filterEncryption(IKey filterEncryption)

Sets the value of StreamEventSourceProps.getFilterEncryption()

Parameters:

filterEncryption - Add Customer managed KMS key to encrypt Filter Criteria.

Returns:

this

filters

@Stability(Stable)
public KinesisEventSourceProps.Builder filters(List<? extends Map<String,? extends Object>> filters)

Sets the value of StreamEventSourceProps.getFilters()

Parameters:

filters - Add filter criteria option.

Returns:

this

maxRecordAge

@Stability(Stable)
public KinesisEventSourceProps.Builder maxRecordAge(Duration maxRecordAge)

Sets the value of StreamEventSourceProps.getMaxRecordAge()

Parameters:

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

The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records. Record are valid until it expires in the event source.

Returns:

this

metricsConfig

@Stability(Stable)
public KinesisEventSourceProps.Builder metricsConfig(MetricsConfig metricsConfig)

Sets the value of StreamEventSourceProps.getMetricsConfig()

Parameters:

metricsConfig - Configuration for enhanced monitoring metrics collection When specified, enables collection of additional metrics for the stream event source.

Returns:

this

onFailure

@Stability(Stable)
public KinesisEventSourceProps.Builder onFailure(IEventSourceDlq onFailure)

Sets the value of StreamEventSourceProps.getOnFailure()

Parameters:

onFailure - An Amazon SQS queue or Amazon SNS topic destination for discarded records.

Returns:

this

parallelizationFactor

@Stability(Stable)
public KinesisEventSourceProps.Builder parallelizationFactor(Number parallelizationFactor)

Sets the value of StreamEventSourceProps.getParallelizationFactor()

Parameters:

parallelizationFactor - The number of batches to process from each shard concurrently. Valid Range:

• Minimum value of 1
• Maximum value of 10

Returns:

this

reportBatchItemFailures

@Stability(Stable)
public KinesisEventSourceProps.Builder reportBatchItemFailures(Boolean reportBatchItemFailures)

Sets the value of StreamEventSourceProps.getReportBatchItemFailures()

Parameters:

reportBatchItemFailures - Allow functions to return partially successful responses for a batch of records.

Returns:

this

retryAttempts

@Stability(Stable)
public KinesisEventSourceProps.Builder retryAttempts(Number retryAttempts)

Sets the value of StreamEventSourceProps.getRetryAttempts()

Parameters:

retryAttempts - Maximum number of retry attempts Valid Range: * Minimum value of 0 * Maximum value of 10000. 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.

Returns:

this

tumblingWindow

@Stability(Stable)
public KinesisEventSourceProps.Builder tumblingWindow(Duration tumblingWindow)

Sets the value of StreamEventSourceProps.getTumblingWindow()

Parameters:

tumblingWindow - The size of the tumbling windows to group records sent to DynamoDB or Kinesis Valid Range: 0 - 15 minutes.

Returns:

this

startingPosition

@Stability(Stable)
public KinesisEventSourceProps.Builder startingPosition(StartingPosition startingPosition)

Sets the value of BaseStreamEventSourceProps.getStartingPosition()

Parameters:

startingPosition - Where to begin consuming the stream. This parameter is required.

Returns:

this

batchSize

@Stability(Stable)
public KinesisEventSourceProps.Builder batchSize(Number batchSize)

Sets the value of BaseStreamEventSourceProps.getBatchSize()

Parameters:

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 DynamoEventSource
  • 10000 for KinesisEventSource, ManagedKafkaEventSource and SelfManagedKafkaEventSource

Returns:

this

enabled

@Stability(Stable)
public KinesisEventSourceProps.Builder enabled(Boolean enabled)

Sets the value of BaseStreamEventSourceProps.getEnabled()

Parameters:

enabled - If the stream event source mapping should be enabled.

Returns:

this

maxBatchingWindow

@Stability(Stable)
public KinesisEventSourceProps.Builder maxBatchingWindow(Duration maxBatchingWindow)

Sets the value of BaseStreamEventSourceProps.getMaxBatchingWindow()

Parameters:

maxBatchingWindow - The maximum amount of time to gather records before invoking the function. Maximum of Duration.minutes(5).

Returns:

this

provisionedPollerConfig

@Stability(Stable)
public KinesisEventSourceProps.Builder provisionedPollerConfig(ProvisionedPollerConfig provisionedPollerConfig)

Sets the value of BaseStreamEventSourceProps.getProvisionedPollerConfig()

Parameters:

provisionedPollerConfig - Configuration for provisioned pollers that read from the event source. When specified, allows control over the minimum and maximum number of pollers that can be provisioned to process events from the source.

Returns:

this

build

@Stability(Stable)
public KinesisEventSourceProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<KinesisEventSourceProps>

Returns:

a new instance of KinesisEventSourceProps

Throws:

NullPointerException - if any required attribute was not provided