Updated on 2025-07-21 GMT+08:00

DMS Kafka Connection Parameters (Internal Test)

Table 1 DMS Kafka connection

Parameter

Mandatory

Description

Data Connection Type

Yes

The value is fixed at DMS Kafka.

Name

Yes

Name of the data connection to create. Data connection names can contain a maximum of 100 characters. They can contain only letters, digits, underscores (_), and hyphens (-).

Description

No

A description which can help identify the data connection more easily. It can contain a maximum of 100 characters.

Tag

No

Attribute of the data connection to create. Tags make management easier.
NOTE:

The tag name can contain only letters, digits, and underscores (_) and cannot start with an underscore (_) or contain more than 100 characters.

Applicable Modules

Yes

Select the modules for which this connection is available.

NOTE:
  • When offline or real-time data migration jobs are enabled, you can select the DataArts Migration module. Then you can select this data connection when creating a data migration job in DataArts Factory.
  • You can use offline or real-time data migration jobs only after you apply for the whitelist membership. To use this feature, contact customer service or technical support.

Basic and Network Connectivity Configuration

Kafka Broker

Yes

The value is in Host IP address:Port format. Examples: 127.0.0.1:9092 and 127.0.0.1:9093

Kafka SASL_SSL

Yes

If Kafka SASL_SSL is enabled, data will be encrypted before transmission for higher security, but performance will suffer. Set the value to security.protocol=SASL_SSL/SASL_PLAINTEXT,sasl.mechanism=PLAIN/SCRAM-SHA-512 based on the Kafka cluster authentication.

KMS Key

Yes

KMS key used to encrypt and decrypt data source authentication information. Select a default or custom key.
NOTE:
  • When you use KMS for encryption through DataArts Studio or KPS for the first time, the default key dlf/default or kps/default is automatically generated. For more information about default keys, see What Is a Default Master Key?.
  • Only symmetric keys are supported. Asymmetric keys are not supported.

Agent

Yes

DataArts Studio cannot directly connect to non-fully managed services. An agent is required for DataArts Studio to communicate with non-fully managed services. A CDM cluster can function as an agent. If no CDM cluster is available, create one by referring to Creating a CDM Cluster.

Data Migration Configuration

Link Attributes

No

Link attributes

  • socketTimeout: JDBC connection timeout duration, in milliseconds
  • mysql.bool.type.transform: whether to parse TinyInt(1) to Boolean during data reading from a MySQL database. The default value is true.

Data Source Authentication and Other Function Configuration

Username

Yes

This parameter is mandatory when Kafka SASL_SSL is enabled.

It indicates the username for connecting to DMS Kafka.

Password

Yes

This parameter is mandatory when Kafka SASL_SSL is enabled.

It indicates the password for connecting to DMS Kafka.