Important

You are viewing documentation for an older version of Confluent Platform. For the latest, click here.

MQTT Sink Connector Configuration Options

The MQTT Sink Connector Connector can be configured using a variety of configuration properties.

Connection

mqtt.server.uri

List of MQTT brokers to connect to.

  • Type: list
  • Importance: high
mqtt.clean.session.enabled

Sets whether the client and server should remember state across restarts and reconnects.

  • Type: boolean
  • Default: true
  • Importance: low
mqtt.connect.timeout.seconds

Sets the connection timeout value.

  • Type: int
  • Default: 30
  • Importance: low
mqtt.keepalive.interval.seconds

Sets the “keep alive” interval.

  • Type: int
  • Default: 60
  • Valid Values: [1,…]
  • Importance: low
mqtt.username

Username to connect with, or blank to connect without a username.

  • Type: string
  • Default: “”
  • Importance: high
mqtt.password

Password to connect with, or blank to connect without a password.

  • Type: password
  • Default: [hidden]
  • Importance: high
mqtt.ssl.trust.store.path

The location of the Java TrustStore file containing the certificates required to validate the SSL connection to the server.

  • Type: string
  • Default: “”
  • Importance: high
mqtt.ssl.trust.store.password

Password used to open the Java TrustStore file.

  • Type: password
  • Default: [hidden]
  • Importance: high
mqtt.ssl.key.store.path

The location of the Java KeyStore file containing the private key to use for authenticating with the server.

  • Type: string
  • Default: “”
  • Importance: high
mqtt.ssl.key.store.password

Password used to open the Java KeyStore file.

  • Type: password
  • Default: [hidden]
  • Importance: high
mqtt.ssl.key.password

Password for the client certificate contained in the Java KeyStore.

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

Confluent Licensing

confluent.license

Confluent will issue a license key to each subscriber. The license key will be a short snippet of text that you can copy and paste. Without the license key, you can use the connector for a 30-day trial period. If you are a subscriber, please contact Confluent Support for more information.

  • Type: string
  • Default: “”
  • Valid Values: Confluent Platform license
  • Importance: high
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 host1:port1,host2:port2,.... These servers are used only for the initial connection to discover the full cluster membership, which may change dynamically, so this list need not contain the full set of servers. You may want more than one, 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

Write

mqtt.qos

The QOS level to write messages to the MQTT broker with.

  • Type: int
  • Default: 0
  • Valid Values: [0,…,2]
  • Importance: medium
mqtt.retained.enabled

Flag to determine if the messages should be retained.

  • Type: boolean
  • Default: true
  • Importance: medium