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

Class SelfManagedKafkaEventSourceProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<SelfManagedKafkaEventSourceProps>

Enclosing interface:

SelfManagedKafkaEventSourceProps

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

A builder for SelfManagedKafkaEventSourceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SelfManagedKafkaEventSourceProps.Builder	authenticationMethod(AuthenticationMethod authenticationMethod)	Sets the value of SelfManagedKafkaEventSourceProps.getAuthenticationMethod()
SelfManagedKafkaEventSourceProps.Builder	batchSize(Number batchSize)	Sets the value of BaseStreamEventSourceProps.getBatchSize()
SelfManagedKafkaEventSourceProps.Builder	bootstrapServers(List<String> bootstrapServers)	Sets the value of SelfManagedKafkaEventSourceProps.getBootstrapServers()
SelfManagedKafkaEventSourceProps	build()	Builds the configured instance.
SelfManagedKafkaEventSourceProps.Builder	consumerGroupId(String consumerGroupId)	Sets the value of KafkaEventSourceProps.getConsumerGroupId()
SelfManagedKafkaEventSourceProps.Builder	enabled(Boolean enabled)	Sets the value of BaseStreamEventSourceProps.getEnabled()
SelfManagedKafkaEventSourceProps.Builder	filterEncryption(IKey filterEncryption)	Sets the value of KafkaEventSourceProps.getFilterEncryption()
SelfManagedKafkaEventSourceProps.Builder	filters(List<? extends Map<String,? extends Object>> filters)	Sets the value of KafkaEventSourceProps.getFilters()
SelfManagedKafkaEventSourceProps.Builder	maxBatchingWindow(Duration maxBatchingWindow)	Sets the value of BaseStreamEventSourceProps.getMaxBatchingWindow()
SelfManagedKafkaEventSourceProps.Builder	onFailure(IEventSourceDlq onFailure)	Sets the value of KafkaEventSourceProps.getOnFailure()
SelfManagedKafkaEventSourceProps.Builder	provisionedPollerConfig(ProvisionedPollerConfig provisionedPollerConfig)	Sets the value of BaseStreamEventSourceProps.getProvisionedPollerConfig()
SelfManagedKafkaEventSourceProps.Builder	rootCaCertificate(ISecret rootCaCertificate)	Sets the value of invalid @link SelfManagedKafkaEventSourceProps#getRootCaCertificate
SelfManagedKafkaEventSourceProps.Builder	secret(ISecret secret)	Sets the value of KafkaEventSourceProps.getSecret()
SelfManagedKafkaEventSourceProps.Builder	securityGroup(ISecurityGroup securityGroup)	Sets the value of SelfManagedKafkaEventSourceProps.getSecurityGroup()
SelfManagedKafkaEventSourceProps.Builder	startingPosition(StartingPosition startingPosition)	Sets the value of BaseStreamEventSourceProps.getStartingPosition()
SelfManagedKafkaEventSourceProps.Builder	topic(String topic)	Sets the value of KafkaEventSourceProps.getTopic()
SelfManagedKafkaEventSourceProps.Builder	vpc(IVpc vpc)	Sets the value of SelfManagedKafkaEventSourceProps.getVpc()
SelfManagedKafkaEventSourceProps.Builder	vpcSubnets(SubnetSelection vpcSubnets)	Sets the value of SelfManagedKafkaEventSourceProps.getVpcSubnets()

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

bootstrapServers

@Stability(Stable)
public SelfManagedKafkaEventSourceProps.Builder bootstrapServers(List<String> bootstrapServers)

Sets the value of SelfManagedKafkaEventSourceProps.getBootstrapServers()

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. They are in the format abc.xyz.com:xxxx.

Returns:

this

authenticationMethod

@Stability(Stable)
public SelfManagedKafkaEventSourceProps.Builder authenticationMethod(AuthenticationMethod authenticationMethod)

Sets the value of SelfManagedKafkaEventSourceProps.getAuthenticationMethod()

Parameters:

authenticationMethod - The authentication method for your Kafka cluster.

Returns:

this

rootCaCertificate

@Stability(Stable)
public SelfManagedKafkaEventSourceProps.Builder rootCaCertificate(ISecret rootCaCertificate)

Sets the value of

invalid @link

SelfManagedKafkaEventSourceProps#getRootCaCertificate

Parameters:

rootCaCertificate - The secret with the root CA certificate used by your Kafka brokers for TLS encryption This field is required if your Kafka brokers use certificates signed by a private CA.

Returns:

this

securityGroup

@Stability(Stable)
public SelfManagedKafkaEventSourceProps.Builder securityGroup(ISecurityGroup securityGroup)

Sets the value of SelfManagedKafkaEventSourceProps.getSecurityGroup()

Parameters:

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

Returns:

this

vpc

@Stability(Stable)
public SelfManagedKafkaEventSourceProps.Builder vpc(IVpc vpc)

Sets the value of SelfManagedKafkaEventSourceProps.getVpc()

Parameters:

vpc - If your Kafka brokers are only reachable via VPC provide the VPC here.

Returns:

this

vpcSubnets

@Stability(Stable)
public SelfManagedKafkaEventSourceProps.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of SelfManagedKafkaEventSourceProps.getVpcSubnets()

Parameters:

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

Returns:

this

topic

@Stability(Stable)
public SelfManagedKafkaEventSourceProps.Builder topic(String topic)

Sets the value of KafkaEventSourceProps.getTopic()

Parameters:

topic - The Kafka topic to subscribe to. This parameter is required.

Returns:

this

consumerGroupId

@Stability(Stable)
public SelfManagedKafkaEventSourceProps.Builder consumerGroupId(String consumerGroupId)

Sets the value of KafkaEventSourceProps.getConsumerGroupId()

Parameters:

consumerGroupId - The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. The value must have a length between 1 and 200 and full the pattern '[a-zA-Z0-9-/:_+=.@-]'.

Returns:

this

filterEncryption

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

Sets the value of KafkaEventSourceProps.getFilterEncryption()

Parameters:

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

Returns:

this

filters

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

Sets the value of KafkaEventSourceProps.getFilters()

Parameters:

filters - Add filter criteria to Event Source.

Returns:

this

onFailure

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

Sets the value of KafkaEventSourceProps.getOnFailure()

Parameters:

onFailure - Add an on Failure Destination for this Kafka event. SNS/SQS/S3 are supported

Returns:

this

secret

@Stability(Stable)
public SelfManagedKafkaEventSourceProps.Builder secret(ISecret secret)

Sets the value of KafkaEventSourceProps.getSecret()

Parameters:

secret - The secret with the Kafka credentials, see https://docs.aws.amazon.com/msk/latest/developerguide/msk-password.html for details This field is required if your Kafka brokers are accessed over the Internet.

Returns:

this

startingPosition

@Stability(Stable)
public SelfManagedKafkaEventSourceProps.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 SelfManagedKafkaEventSourceProps.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 SelfManagedKafkaEventSourceProps.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 SelfManagedKafkaEventSourceProps.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 SelfManagedKafkaEventSourceProps.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 SelfManagedKafkaEventSourceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SelfManagedKafkaEventSourceProps

Throws:

NullPointerException - if any required attribute was not provided