AMPS Source Connector Configuration Properties

To use this connector, specify the name of the connector class in the connector.class configuration property.

connector.class=io.confluent.connect.amps.AmpsSourceConnector

Connector-specific configuration properties are described below.

Base

kafka.topic

The Kafka topic to publish records to.

  • Type: string
  • Importance: high

Auto topic creation

For more information about Auto topic creation, see Configuring Auto Topic Creation for Source Connectors.

Note

Configuration properties accept regular expressions (regex) that are defined as Java regex.

topic.creation.groups

A list of group aliases that are used to define per-group topic configurations for matching topics. A default group always exists and matches all topics.

  • Type: List of String types
  • Default: empty
  • Possible Values: The values of this property refer to any additional groups. A default group is always defined for topic configurations.
topic.creation.$alias.replication.factor

The replication factor for new topics created by the connector. This value must not be larger than the number of brokers in the Kafka cluster. If this value is larger than the number of Kafka brokers, an error occurs when the connector attempts to create a topic. This is a required property for the default group. This property is optional for any other group defined in topic.creation.groups. Other groups use the Kafka broker default value.

  • Type: int
  • Default: n/a
  • Possible Values: >= 1 for a specific valid value or -1 to use the Kafka broker’s default value.
topic.creation.$alias.partitions

The number of topic partitions created by this connector. This is a required property for the default group. This property is optional for any other group defined in topic.creation.groups. Other groups use the Kafka broker default value.

  • Type: int
  • Default: n/a
  • Possible Values: >= 1 for a specific valid value or -1 to use the Kafka broker’s default value.
topic.creation.$alias.include

A list of strings that represent regular expressions that match topic names. This list is used to include topics with matching values, and apply this group’s specific configuration to the matching topics. $alias applies to any group defined in topic.creation.groups. This property does not apply to the default group.

  • Type: List of String types
  • Default: empty
  • Possible Values: Comma-separated list of exact topic names or regular expressions.
topic.creation.$alias.exclude

A list of strings representing regular expressions that match topic names. This list is used to exclude topics with matching values from getting the group’s specfic configuration. $alias applies to any group defined in topic.creation.groups. This property does not apply to the default group. Note that exclusion rules override any inclusion rules for topics.

  • Type: List of String types
  • Default: empty
  • Possible Values: Comma-separated list of exact topic names or regular expressions.
topic.creation.$alias.${kafkaTopicSpecificConfigName}

Any of the Changing Broker Configurations Dynamically for the version of the Kafka broker where the records will be written. The broker’s topic-level configuration value is used if the configuration is not specified for the rule. $alias applies to the default group as well as any group defined in topic.creation.groups.

  • Type: property values
  • Default: Kafka broker value

Connection

amps.servers

Comma-separated list of AMPS server URIs. The URIs are of the form scheme://[userinfo@]host[:port]/. The scheme is limited to tcp. For example: tcp://user@mydomain:9007/, tcp://mydomain-bkp:9004/.

  • Type: list
  • Valid Values: a non-empty list or URI with one of these schemes: tcp
  • Importance: high
amps.topic

The AMPS topic to subscribe to.

  • Type: string
  • Importance: high
amps.topic.type

This setting specifies if the topic is an SOW or is added to Transactional logged, or neither. The setting can be one of SOW, TRANSACTION_LOG, or NONE.

  • Type: string
  • Default: NONE
  • Valid Values: one of [TRANSACTION_LOG, SOW, NONE]
  • Importance: high
amps.protocol

The protocol to be used while subscribing to the topic. This setting can be one of AMPS, FIX, XML, NVFIX, or WEBSOCKET.

  • Type: string
  • Default: AMPS
  • Valid Values: one of [AMPS, FIX, XML, NVFIX, WEBSOCKET]
  • Importance: high
amps.message.type

The message type to subscribe to when connecting. This setting is case-sensitive and can be one of bflat, binary, json, fix, nvfix or any non-null string.

  • Type: string
  • Default: json
  • Valid Values: either one of [fix, binary, nvfix, json, bflat], or non-null string
  • Importance: high
amps.command

The command to use when subscribing to the server. This setting can be one of SOW, SOW_AND_SUBSCRIBE, or SUBSCRIBE.

  • Type: string
  • Default: SUBSCRIBE
  • Valid Values: one of [SOW, SOW_AND_SUBSCRIBE, SUBSCRIBE]
  • Importance: high
amps.options

This setting specifies the list of options to be used when subscribing to the topic. The list can contain multiple options from LIVE, NO_EMPTIES, NO_SOWKEY, OOF, SEND_KEYS, TIMESTAMP, and BOOKMARK.

  • Type: list
  • Default: “”
  • Valid Values: one of [SEND_KEYS, OOF, TIMESTAMP, NO_SOWKEY, BOOKMARK, NO_EMPTIES, LIVE]
  • Importance: medium
amps.filter

The filter to be used when subscribing to a topic. For example, /order/type = 'bulk' and /order/qty > 10.

  • Type: string
  • Default: null
  • Importance: medium
amps.select

A list of field directives that specify which fields are retrieved and which are not, when subscribing to a topic. For example, [-/,+/event_id,+/description]

  • Type: list
  • Default: “”
  • Valid Values: either begins with ‘+/’, or begins with ‘-/’
  • Importance: medium
amps.bookmark

Specifies the bookmark to be used while subscribing. This config can be one of EPOCH (replay log and then subscribe to live) or NOW (subscribe to live messages). This setting is ignored when the amps.topic.type isn’t TRANSACTION_LOG.

  • Type: string
  • Default: NOW
  • Valid Values: one of [NOW, EPOCH]
  • Importance: medium
amps.batch.size

Specifies the number of records that must be returned from AMPS in a batch during a query.

  • Type: int
  • Default: 10
  • Importance: low
amps.reconnect.timeout

Specifies the maximum time to wait (in milliseconds) for a server response before failure. A setting of 0 implies no timeout.

  • Type: long
  • Default: 0
  • Importance: low

Source

batch.size

The number of records that should be returned to Kafka in each batch.

  • Type: int
  • Default: 100
  • Importance: medium
forward.kafka.headers

Specifies if the AMPS message headers have to be forwarded as Kafka record headers.

  • Type: boolean
  • Default: false
  • Importance: low

Kerberos

amps.kerberos.principal

The user principal to use for Kerberos authentication.

  • Type: string
  • Default: null
  • Importance: high
amps.kerberos.keytab

The keytab file to use for Kerberos authentication.

  • Type: string
  • Default: null
  • Importance: high

Confluent Platform license

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,.... Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list doesn’t need to contain the full set of servers (you may want more than one, though, 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

Confluent license properties

Tip

While it is possible to include license-related properties in the connector configuration, starting with Confluent Platform version 6.0, you can now put license-related properties in the Connect worker configuration instead of in each connector configuration.

Note

This connector is proprietary and requires a license. The license information is stored in the _confluent-command topic. If the broker requires SSL for connections, you must include the security-related confluent.topic.* properties as described below.

confluent.license

Confluent issues enterprise license keys to each subscriber. The license key is text that you can copy and paste as the value for confluent.license. A trial license allows using the connector for a 30-day trial period. A developer license allows using the connector indefinitely for single-broker development environments.

If you are a subscriber, please contact Confluent Support for more information.

  • Type: string
  • Default: “”
  • Valid Values: Confluent Platform license
  • Importance: high
confluent.topic.ssl.truststore.location

The location of the trust store file.

  • Type: string
  • Default: null
  • Importance: high
confluent.topic.ssl.truststore.password

The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled.

  • Type: password
  • Default: null
  • Importance: high
confluent.topic.ssl.keystore.location

The location of the key store file. This is optional for client and can be used for two-way authentication for client.

  • Type: string
  • Default: null
  • Importance: high
confluent.topic.ssl.keystore.password

The store password for the key store file. This is optional for client and only needed if ssl.keystore.location is configured.

  • Type: password
  • Default: null
  • Importance: high
confluent.topic.ssl.key.password

The password of the private key in the key store file. This is optional for client.

  • Type: password
  • Default: null
  • Importance: high
confluent.topic.security.protocol

Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.

  • Type: string
  • Default: “PLAINTEXT”
  • Importance: medium

License topic configuration

A Confluent enterprise license is stored in the _confluent-command topic. This topic is created by default and contains the license that corresponds to the license key supplied through the confluent.license property.

Note

No public keys are stored in Kafka topics.

The following describes how the default _confluent-command topic is generated under different scenarios:

  • A 30-day trial license is automatically generated for the _confluent command topic if you do not add the confluent.license property or leave this property empty (for example, confluent.license=).
  • Adding a valid license key (for example, confluent.license=<valid-license-key>) adds a valid license in the _confluent-command topic.

Here is an example of the minimal properties for development and testing.

You can change the name of the _confluent-command topic using the confluent.topic property (for instance, if your environment has strict naming conventions). The example below shows this change and the configured Kafka bootstrap server.

confluent.topic=foo_confluent-command
confluent.topic.bootstrap.servers=localhost:9092

The example above shows the minimally required bootstrap server property that you can use for development and testing. For a production environment, you add the normal producer, consumer, and topic configuration properties to the connector properties, prefixed with confluent.topic..

Overriding Default Configuration Properties

You can override the replication factor using confluent.topic.replication.factor. For example, when using a Kafka cluster as a destination with less than three brokers (for development and testing) you should set the confluent.topic.replication.factor property to 1.

You can override producer-specific properties by using the confluent.topic.producer. prefix and consumer-specific properties by using the confluent.topic.consumer. prefix.

You can use the defaults or customize the other properties as well. For example, the confluent.topic.client.id property defaults to the name of the connector with -licensing suffix. You can specify the configuration settings for brokers that require SSL or SASL for client connections using this prefix.

You cannot override the cleanup policy of a topic because the topic always has a single partition and is compacted. Also, do not specify serializers and deserializers using this prefix; they are ignored if added.