software.amazon.awscdk.services.lambda.eventsources

Class SelfManagedKafkaEventSource.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<SelfManagedKafkaEventSource>

Enclosing class:

SelfManagedKafkaEventSource

@Stability(value=Experimental)
public static final class SelfManagedKafkaEventSource.Builder
extends Object
implements software.amazon.jsii.Builder<SelfManagedKafkaEventSource>

(experimental) A fluent builder for SelfManagedKafkaEventSource.

Method Summary

Modifier and Type	Method and Description
SelfManagedKafkaEventSource.Builder	authenticationMethod(AuthenticationMethod authenticationMethod) (experimental) The authentication method for your Kafka cluster.
SelfManagedKafkaEventSource.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.
SelfManagedKafkaEventSource.Builder	bisectBatchOnError(Boolean bisectBatchOnError) (experimental) If the function returns an error, split the batch in two and retry.
SelfManagedKafkaEventSource.Builder	bootstrapServers(List<String> bootstrapServers) (experimental) The list of host and port pairs that are the addresses of the Kafka brokers in a "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself.
SelfManagedKafkaEventSource	build()
static SelfManagedKafkaEventSource.Builder	create()
SelfManagedKafkaEventSource.Builder	enabled(Boolean enabled) (experimental) If the stream event source mapping should be enabled.
SelfManagedKafkaEventSource.Builder	maxBatchingWindow(Duration maxBatchingWindow) (experimental) The maximum amount of time to gather records before invoking the function.
SelfManagedKafkaEventSource.Builder	maxRecordAge(Duration maxRecordAge) (experimental) The maximum age of a record that Lambda sends to a function for processing.
SelfManagedKafkaEventSource.Builder	onFailure(IEventSourceDlq onFailure) (experimental) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
SelfManagedKafkaEventSource.Builder	parallelizationFactor(Number parallelizationFactor) (experimental) The number of batches to process from each shard concurrently.
SelfManagedKafkaEventSource.Builder	retryAttempts(Number retryAttempts) (experimental) Maximum number of retry attempts Valid Range: * Minimum value of 0 * Maximum value of 10000.
SelfManagedKafkaEventSource.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.
SelfManagedKafkaEventSource.Builder	securityGroup(ISecurityGroup securityGroup) (experimental) If your Kafka brokers are only reachable via VPC, provide the security group here.
SelfManagedKafkaEventSource.Builder	startingPosition(StartingPosition startingPosition) (experimental) Where to begin consuming the stream.
SelfManagedKafkaEventSource.Builder	topic(String topic) (experimental) the Kafka topic to subscribe to.
SelfManagedKafkaEventSource.Builder	tumblingWindow(Duration tumblingWindow) (experimental) The size of the tumbling windows to group records sent to DynamoDB or Kinesis Valid Range: 0 - 15 minutes.
SelfManagedKafkaEventSource.Builder	vpc(IVpc vpc) (experimental) If your Kafka brokers are only reachable via VPC provide the VPC here.
SelfManagedKafkaEventSource.Builder	vpcSubnets(SubnetSelection vpcSubnets) (experimental) If your Kafka brokers are only reachable via VPC, provide the subnets selection here.

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 SelfManagedKafkaEventSource.Builder create()

Returns:

a new instance of SelfManagedKafkaEventSource.Builder.

startingPosition

@Stability(value=Experimental)
public SelfManagedKafkaEventSource.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 SelfManagedKafkaEventSource.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 SelfManagedKafkaEventSource.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 SelfManagedKafkaEventSource.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 SelfManagedKafkaEventSource.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 SelfManagedKafkaEventSource.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 SelfManagedKafkaEventSource.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 SelfManagedKafkaEventSource.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 SelfManagedKafkaEventSource.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 SelfManagedKafkaEventSource.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 SelfManagedKafkaEventSource.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 SelfManagedKafkaEventSource.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

bootstrapServers

@Stability(value=Experimental)
public SelfManagedKafkaEventSource.Builder bootstrapServers(List<String> bootstrapServers)

(experimental) The list of host and port pairs that are the addresses of the Kafka brokers in a "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself.

They are in the format abc.xyz.com:xxxx.

Parameters:

bootstrapServers - The list of host and port pairs that are the addresses of the Kafka brokers in a "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself. This parameter is required.

Returns:

this

authenticationMethod

@Stability(value=Experimental)
public SelfManagedKafkaEventSource.Builder authenticationMethod(AuthenticationMethod authenticationMethod)

(experimental) The authentication method for your Kafka cluster.

Default: AuthenticationMethod.SASL_SCRAM_512_AUTH

Parameters:

authenticationMethod - The authentication method for your Kafka cluster. This parameter is required.

Returns:

this

securityGroup

@Stability(value=Experimental)
public SelfManagedKafkaEventSource.Builder securityGroup(ISecurityGroup securityGroup)

(experimental) If your Kafka brokers are only reachable via VPC, provide the security group here.

Default: - none, required if setting vpc

Parameters:

securityGroup - If your Kafka brokers are only reachable via VPC, provide the security group here. This parameter is required.

Returns:

this

vpc

@Stability(value=Experimental)
public SelfManagedKafkaEventSource.Builder vpc(IVpc vpc)

(experimental) If your Kafka brokers are only reachable via VPC provide the VPC here.

Default: none

Parameters:

vpc - If your Kafka brokers are only reachable via VPC provide the VPC here. This parameter is required.

Returns:

this

vpcSubnets

@Stability(value=Experimental)
public SelfManagedKafkaEventSource.Builder vpcSubnets(SubnetSelection vpcSubnets)

(experimental) If your Kafka brokers are only reachable via VPC, provide the subnets selection here.

Default: - none, required if setting vpc

Parameters:

vpcSubnets - If your Kafka brokers are only reachable via VPC, provide the subnets selection here. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public SelfManagedKafkaEventSource build()

Specified by:

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