Connections > Connection properties > Kafka connection properties
  

Kafka connection properties

When you set up a Kafka connection, you must configure the connection properties.
The following table describes the Kafka connection properties:
Property
Description
Connection Name
Name of the connection.
The name is not case sensitive. It must be unique within the domain. You can change this property after you create the connection. The name cannot exceed 128 characters, contain spaces, or contain the following special characters:
~ ` ! $ % ^ & * ( ) - + = { [ } ] | \ : ; " ' < , > . ? /
Description
Optional. Description that you use to identity the connection.
The description cannot exceed 4,000 characters.
Type
The Kafka connection type.
If you do not see the connection type, go to the Add-On Connectors page in Administrator to install the connector.
Runtime Environment
Name of the runtime environment where you want to run the tasks.
Kafka Broker List
Comma-separated list of the Kafka brokers.
To list a Kafka broker, use the following format:
<HostName>:<PortNumber>
Note: When you connect to a Kafka broker over SSL, you must specify the fully qualified domain name for the host name. Otherwise, the test connection fails with SSL handshake error.
Retry Timeout
Optional. Number of seconds after which the Secure Agent attempts to reconnect to the Kafka broker to read or write data.
Default is 180 seconds.
Kafka Broker Version
Kafka message broker version. The only valid value is Apache 0.10.1.1 and above.
Additional Connection Properties
Optional. Comma-separated list of additional configuration properties of the Kafka producer or consumer.
SSL Mode¹
Required. SSL mode indicates the encryption type to use for the connection.
You can choose a mode from the following SSL modes:
  • - Disabled. Secure Agent establishes an unencrypted connection to the Kafka broker.
  • - One-way. Secure Agent establishes an encrypted connection to the Kafka broker using truststore file and truststore password.
  • - Two-way. Secure Agent establishes an encrypted connection to the Kafka broker using truststore file and truststore password.
SSL TrustStore File Path¹
Required when you use the one-way or two-way SSL mode.
Absolute path and file name of the SSL truststore file. The truststore file contains the SSL certificate that the Kafka cluster validates against the Kafka broker certificate.
SSL TrustStore Password¹
Required when you use the one-way or two-way SSL mode.
Password for the SSL truststore.
SSL KeyStore File Path¹
Required when you use the two-way SSL mode.
Absolute path and file name of the SSL keystore file that contains private keys and certificates that the Kafka broker validates against the Kafka cluster certificate.
SSL KeyStore Password¹
Required when you use the two-way SSL mode.
Password for the SSL keystore.
Additional Security Properties
Optional. Comma-separated list of additional configuration properties to connect to the Kafka broker in a secured way.
If you specify two different values for the same property in Additional Connection Properties and Additional Security Properties, the value in Additional Security Properties overrides the value in Additional Connection Properties.
¹ Does not apply to elastic mappings.