Connections > 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.
Specify a Secure Agent or a serverless runtime environment for a mapping that runs on the advanced cluster.
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.
This property is not used by Mass Ingestion Databases. You can specify an equivalent Kafka property in Additional Connection Properties.
Kafka Broker Version
Kafka message broker version. The only valid value is Apache 0.10.1.1 and above.
Optional for a streaming ingestion task.
Additional Connection Properties
Optional. Comma-separated list of additional configuration properties of the Kafka producer or consumer.
For a streaming ingestion task, ensure that you set the <kerberos name> property if you configure <Security Protocol> as SASL_PLAINTEXT or SASL_SSL.
For a database ingestion task, if you want to specify a security protocol and properties, specify them here instead of in the Additional Security Properties property. For example: security.protocol=SSL,ssl.truststore.location=/opt/kafka/config/kafka.truststore.jks,ssl.truststore.password=<trustore_password>.
Schema Registry URL
Location and port of the Confluent schema registry service to access Avro sources and targets in Kafka.
To list a schema registry URL, use the following format:
<https>://<HostName or IP>:<PortNumber>
or
<http>://<HostName or IP>:<PortNumber>
Example for the schema registry URL:
https://kafkarnd.informatica.com:8082
or
http://10.65.146.181:8084
Applies only when you import a Kafka topic in Avro format that uses the Confluent schema registry to store the metadata.
This property is not used by Mass Ingestion Databases. You can specify an equivalent Kafka property in Additional Connection Properties.
SSL Mode
Required. Determines the encryption type to use for the connection.
You can choose a mode from the following SSL modes:
  • - Disabled. Establishes an unencrypted connection to the Kafka broker.
  • - One-way. Establishes an encrypted connection to the Kafka broker using truststore file and truststore password.
  • - Two-way. Establishes an encrypted connection to the Kafka broker using truststore file, truststore password, keystore file, and keystore password.
This property is not used by Mass Ingestion Databases. You can specify an equivalent Kafka property in Additional Connection Properties.
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 that contains the SSL certificate to connect to the Kafka broker.
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 to connect to the Kafka broker.
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 secure 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.
This property is not used by Mass Ingestion Databases. You can specify a security protocol and properties in Additional Connection Properties.

Schema Registry Security Configuration Properties

When you configure the Schema Registry URL connection property, you can configure the schema registry security configuration properties. You can configure one-way SSL, two-way SSL, and basic authentication to connect to the Confluent schema registry in a secure way.
The following table describes the security properties for the Kafka connection when you use the Confluent schema registry:
Property
Description
SSL Mode Schema Registry¹
Required. Determines the encryption type to use for the connection.
You can choose a mode from the following SSL modes:
  • - Disabled. Establishes an unencrypted connection to the Confluent schema registry.
  • - One-way. Establishes an encrypted connection to the Confluent schema registry using truststore file and truststore password.
  • - Two-way. Establishes an encrypted connection to the Confluent schema registry using truststore file, truststore password, keystore file, and keystore password.
This property is not used by Mass Ingestion Databases. You can specify an equivalent Kafka property in Additional Connection Properties.
SSL TrustStore File Path Schema Registry¹
Required when you use the one-way or two-way SSL mode.
Absolute path and file name of the SSL truststore file that contains the SSL certificate to connect to the Confluent schema registry.
SSL TrustStore Password Schema Registry¹
Required when you use the one-way or two-way SSL mode.
Password for the SSL truststore.
SSL KeyStore File Path Schema Registry¹
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 to connect to the Confluent schema registry.
SSL KeyStore Password Schema Registry¹
Required when you use the two-way SSL mode.
Password for the SSL keystore.
Additional Security Properties Schema Registry
Optional. Comma-separated list of additional security properties to connect to the Confluent schema registry in a secure way.
For example, when you configure basic authentication to establish a secure communication with Confluent schema registry, specify the following value:
basic.auth.credentials.source=USER_INFO,basic.auth.user.info=<username>:<password>
If you specify two different values for the same property in Additional Connection Properties and Additional Security Properties Schema Registry, the value in Additional Security Properties Schema Registry overrides the value in Additional Connection Properties.
This property is not used by Mass Ingestion Databases.
¹ Does not apply to mappings.