MQTT Source properties reference

Review the following reference for a comprehensive list of the connector properties that are specific to the MQTT Source connector.

The properties listed in this reference must be added to the connector configuration with the following prefix:
parameter.[***CONNECTOR NAME***] Parameters:

In addition to the properties listed here, this connector also accepts certain properties of the Kafka Connect framework as well as the properties of the NiFi Stateless Source connector. When creating a new connector using the SMM UI, all valid properties are presented in the default configuration template. You can view the configuration template to get a full list of valid properties. In addition, for more information regarding the accepted properties not listed here, you can review the Apache Kafka documentation and the Stateless NiFi Source properties reference.

Keystore Filename

Description
The fully-qualified filename of a keystore. This keystore is used for mutual TLS towards the MQTT server.

If the MQTT broker does not require client certificate authentication, this property must be completely removed from the configuration JSON.

Default Value
Accepted Values
Required
false

Keystore Key Password

Description
The password used to access the key stored in the keystore file configured in the Keystore Filename property.

If the MQTT broker does not require client certificate authentication, this property must be completely removed from the configuration JSON.

Default Value
Accepted Values
Required
false

Keystore Password

Description
The password used to access the contents keystore configured in the Keystore Filename property.

If the MQTT broker does not require client certificate authentication, this property must be completely removed from the configuration JSON.

Default Value
Accepted Values
Required
false

Keystore Type

Description
The type of the keystore configured in the Keystore Filename property.

If the MQTT broker does not require client certificate authentication, this property must be completely removed from the configuration JSON.

Default Value
Accepted Values
BCFKS, PKCS12, JKS
Required
false

MQTT Broker URI

Description
The URI to use to connect to the MQTT broker.

Example URI if SSL is not used (keystore-related parameters are removed and and the default truststore is used): tcp://localhost:1883

Example URI if SSL is used: ssl://localhost:8883

Default Value
tcp://localhost:1883
Accepted Values
Required
true

MQTT Password

Description
Password to use when connecting to the MQTT broker.

If username-password authentication is not required by the MQTT broker, this property must be completely removed from the configuration JSON.

Default Value
Accepted Values
Required
false

MQTT Quality of Service

Description
The Quality of Service (QoS) to receive the message with.

0 - at most once

1 - at least once

2 - exactly once

Default Value
0
Accepted Values
0,1 or 2
Required
true

MQTT Topics

Description

A comma-separated list of MQTT topics to subscribe to.

Default Value
Accepted Values
Required
true

MQTT Username

Description
Username to use when connecting to the MQTT broker.

If username-password authentication is not required by the MQTT broker, this property must be completely removed from the configuration JSON.

Default Value
Accepted Values
Required
false

Truststore Filename

Description
The fully-qualified filename of a truststore. This truststore is used to establish a secure connection with the MQTT server using TLS.
Default Value

The location of the default truststore which is empty and can only be used for unsecure connections.

Accepted Values
Required
true

Truststore Password

Description
The password used to access the contents of the truststore configured in the Truststore Filename property.
Default Value
password
Accepted Values
Required
true

Truststore Type

Description
The type of the truststore configured in the Truststore Filename property.
Default Value
JKS
Accepted Values
BCFKS, PKCS12, JKS
Required
true