SAService Architect Back to designer
SAService ArchitectDocumentation
Data connector Kafka

Kafka connector

Kafka cluster connection and security settings.

When to use

Configure this object once per external system or listener. Add concrete routes, methods, topics or schedules as endpoints inside it.

Behavior

  • Owns transport-level connection and implementation settings.
  • Can contain multiple endpoints.
  • Input and Sink streams reference endpoints, not the connector directly.

General properties

Connector identity and language-specific runtime adapters

PropertyTypeDescription
namestring

Connector name used in the designer and generated symbols.

Required
typeDataConnectorType

External system kind. It is locked after endpoints are created.

RequiredAllowed: HTTP, gRPC, Kafka, Custom, Cron, Temporal
goImplementationimplementation

Runtime adapter selected for this target language.

RequiredAllowed: IBM/Sarama
cppUserverImplementationimplementation

Runtime adapter selected for this target language.

RequiredAllowed: userver/kafka
cppBoostImplementationimplementation

Runtime adapter selected for this target language.

RequiredAllowed: librdkafka
pythonImplementationimplementation

Runtime adapter selected for this target language.

RequiredAllowed: aiokafka
rustImplementationimplementation

Runtime adapter selected for this target language.

RequiredAllowed: rust/rdkafka
typeScriptImplementationimplementation

Runtime adapter selected for this target language.

RequiredAllowed: confluent/kafka-javascript

Kafka properties

Kafka-specific connection settings

PropertyTypeDescription
brokersstring

Comma-separated broker addresses.

RequiredDefault: localhost:9092
securityProtocolPLAINTEXT | SASL_PLAINTEXT | SASL_SSL

Transport security mode.

Default: PLAINTEXTAllowed: PLAINTEXT, SASL_PLAINTEXT, SASL_SSL
saslMechanismPLAIN | SCRAM-SHA-256 | SCRAM-SHA-512

SASL authentication mechanism.

Visible for SASL protocols.Allowed: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512
usernamestring

SASL username.

Visible for SASL protocols.
passwordsecret

SASL password supplied through runtime overrides.

Visible for SASL protocols.
versionstring

Broker protocol version.

Default: 2.8.0
dialTimeoutmilliseconds

Connection timeout.

Default: 10000Minimum: 0

Configuration example

type: Kafka
brokers: kafka:9092
securityProtocol: PLAINTEXT