Configuration Properties

To use this connector, specify the name of the connector class in the connector.class configuration property.

connector.class=io.confluent.connect.aws.lambda.AwsLambdaSinkConnector

Connector-specific configuration properties are described below.

AWS Lambda

aws.lambda.function.name

The AWS Lambda function to invoke.

  • Type: string
  • Valid Values: non-empty string
  • Importance: high
aws.lambda.invocation.type

The mode in which the AWS Lambda function is invoked. Supported modes are:

sync
In this mode, records are processed sequentially. The result or error from AWS Lambda function can optionally be saved to an Kafka topic, follow the Response Handling section.
async
In this mode, records may not be processed sequentially. The connector does not save the result or error from the AWS Lambda function execution. You can configure a dead letter queue in AWS to record function errors.
  • Type: string
  • Default: sync
  • Valid Values: [sync, async]
  • Importance: high
aws.lambda.batch.size

The maximum number of Kafka records to combine in a single AWS Lambda function invocation. You should set this as high as possible, without exceeding AWS Lambda invocation payload limits. To disable batching of records, set this value to 1.

  • Type: int
  • Default: 20
  • Valid Values: [1,…]
  • Importance: high
record.converter.class

Record converter class to convert Kafka records to AWS Lambda payload. By default, the connector uses JsonKeyValueConverter.

  • Type: class
  • Default: io.confluent.connect.aws.lambda.converters.JsonKeyValueConverter
  • Importance: low
behavior.on.error

The error handling behavior for AWS Lambda function invocations must be set to one of the following parameters:

fail
Stops the connector in case of an error.
ignore
Continues to process next set of records.
log
Logs the error message in an Kafka topic and continues processing. See aws.lambda.error.topic.
  • Type: string
  • Default: fail
  • Valid Values: [fail, ignore, log]
  • Importance: medium
aws.credentials.provider.class

Credentials provider or provider chain to use for authentication to AWS. By default, the connector uses DefaultAWSCredentialsProviderChain.

  • Type: class
  • Default: com.amazonaws.auth.DefaultAWSCredentialsProviderChain
  • Valid Values: Any class implementing: interface com.amazonaws.auth.AWSCredentialsProvider
  • Importance: low

Response Handling

aws.lambda.response.topic

The Kafka topic in which the results from AWS Lambda function execution are logged. Also provide the Kafka producer configuration parameters such as bootstrap.servers and client.id with aws.lambda.response. as prefix.

  • Type: string
  • Default: “”
  • Importance: medium
aws.lambda.error.topic

The Kafka topic in which errors from AWS Lambda function execution are logged. Also provide the Kafka producer configuration parameters such as bootstrap.servers and client.id with aws.lambda.error. as prefix.

  • Type: string
  • Default: “”
  • Importance: medium
result.handler.class

Result handler class to process response from AWS Lambda function and log to Kafka topic. Configure aws.lambda.response.topic in the case where the response from AWS Lambda function have to be logged. By default, the connector uses LambdaResultHandler.

  • Type: class
  • Default: io.confluent.connect.aws.lambda.handlers.LambdaResultHandler
  • Importance: low
error.handler.class

Error handler class to process errors from AWS Lambda function and log to Kafka topic. Configure aws.lambda.error.topic in the case where the error from AWS Lambda function have to be logged. By default, the connector uses LambdaErrorHandler.

  • Type: class
  • Default: io.confluent.connect.aws.lambda.handlers.LambdaErrorHandler
  • Importance: low

Proxy Configuration

aws.lambda.proxy.url

HTTPS Proxy Server URL. This property is meant to be used only if you need to access AWS Lambda through an HTTPS proxy.

  • Type: string
  • Default: “”
  • Importance: low
aws.lambda.proxy.user

HTTPS Proxy User. This property is meant to be used only if you need to access AWS Lambda through a proxy. Using aws.lambda.proxy.user instead of embedding the username and password in aws.lambda.proxy.url allows the password to be hidden in the logs.

  • Type: string
  • Default: “”
  • Importance: low
aws.lambda.proxy.password

HTTPS Proxy Password. This property is meant to be used only if you need to access AWS Lambda through a proxy. Using aws.lambda.proxy.password instead of embedding the username and password in aws.lambda.proxy.url allows the password to be hidden in the logs.

  • Type: password
  • Default: [hidden]
  • Importance: low

Confluent Platform license

confluent.topic.bootstrap.servers A list of host/port pairs to use for establishing the initial connection to the Kafka cluster used for licensing. All servers in the cluster will be discovered from the initial connection. This list should be in the form <code>host1:port1,host2:port2,…</code>. Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).

  • Type: list
  • Importance: high

confluent.topic Name of the Kafka topic used for Confluent Platform configuration, including licensing information.

  • Type: string
  • Default: _confluent-command
  • Importance: low

confluent.topic.replication.factor The replication factor for the Kafka topic used for Confluent Platform configuration, including licensing information. This is used only if the topic does not already exist, and the default of 3 is appropriate for production use. If you are using a development environment with less than 3 brokers, you must set this to the number of brokers (often 1).

  • Type: int
  • Default: 3
  • Importance: low

Confluent license properties

Note

This connector is proprietary and requires a license. The license information is stored in the _confluent-command topic. If the broker requires SSL for connections, you must include the security-related confluent.topic.* properties as described below.

confluent.license

Confluent issues enterprise license keys to each subscriber. The license key is text that you can copy and paste as the value for confluent.license. A trial license allows using the connector for a 30-day trial period. A developer license allows using the connector indefinitely for single-broker development environments.

If you are a subscriber, please contact Confluent Support for more information.

  • Type: string
  • Default: “”
  • Valid Values: Confluent Platform license
  • Importance: high
confluent.topic.ssl.truststore.location

The location of the trust store file.

  • Type: string
  • Default: null
  • Importance: high
confluent.topic.ssl.truststore.password

The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled.

  • Type: password
  • Default: null
  • Importance: high
confluent.topic.ssl.keystore.location

The location of the key store file. This is optional for client and can be used for two-way authentication for client.

  • Type: string
  • Default: null
  • Importance: high
confluent.topic.ssl.keystore.password

The store password for the key store file. This is optional for client and only needed if ssl.keystore.location is configured.

  • Type: password
  • Default: null
  • Importance: high
confluent.topic.ssl.key.password

The password of the private key in the key store file. This is optional for client.

  • Type: password
  • Default: null
  • Importance: high
confluent.topic.security.protocol

Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.

  • Type: string
  • Default: “PLAINTEXT”
  • Importance: medium

License topic configuration

A Confluent enterprise license is stored in the _confluent-command topic. This topic is created by default and contains the license that corresponds to the license key supplied through the confluent.license property.

Note

No public keys are stored in Kafka topics.

The following describes how the default _confluent-command topic is generated under different scenarios:

  • A 30-day trial license is automatically generated for the _confluent command topic if you do not add the confluent.license property or leave this property empty (for example, confluent.license=).
  • Adding a valid license key (for example, confluent.license=<valid-license-key>) adds a valid license in the _confluent-command topic.

Here is an example of the minimal properties for development and testing.

You can change the name of the _confluent-command topic using the confluent.topic property (for instance, if your environment has strict naming conventions). The example below shows this change and the configured Kafka bootstrap server.

confluent.topic=foo_confluent-command
confluent.topic.bootstrap.servers=localhost:9092

The example above shows the minimally required bootstrap server property that you can use for development and testing. For a production environment, you add the normal producer, consumer, and topic configuration properties to the connector properties, prefixed with confluent.topic..

Overriding Default Configuration Properties

You can override the replication factor using confluent.topic.replication.factor. For example, when using an Kafka cluster as a destination with less than three brokers (for development and testing) you should set the confluent.topic.replication.factor property to 1.

You can override producer-specific properties by using the confluent.topic.producer. prefix and consumer-specific properties by using the confluent.topic.consumer. prefix.

You can use the defaults or customize the other properties as well. For example, the confluent.topic.client.id property defaults to the name of the connector with -licensing suffix. You can specify the configuration settings for brokers that require SSL or SASL for client connections using this prefix.

You cannot override the cleanup policy of a topic because the topic always has a single partition and is compacted. Also, do not specify serializers and deserializers using this prefix; they are ignored if added.