Important

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

Configuration Properties

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

connector.class=io.confluent.connect.http.HttpSinkConnector

Connector-specific configuration properties are described below.

Connection

http.api.url

HTTP API URL.

  • Type: string
  • Importance: high
request.method

HTTP Request Method.

  • Type: string
  • Default: POST
  • Importance: high
behavior.on.null.values

How to handle records with a non-null key and a null value (i.e. Kafka tombstone records). Valid options are ignore, delete, and fail.

  • Type: string
  • Default: ignore
  • Valid Values: [ignore, delete, fail]
  • Importance: low
headers

Character separated HTTP headers. Default separator is |, use header.separator to modify this.

  • Type: string
  • Default: “”
  • Importance: high
header.separator

Separator character used in headers property.

  • Type: string
  • Default: |
  • Importance: high
ssl.enabled

Whether or not to connect to the endpoint via SSL.

  • Type: boolean
  • Default: false
  • Importance: high
http.proxy.host

The host or ip of the http proxy.

  • Type: string
  • Default: “”
  • Importance: high
http.proxy.port

The port number of the http proxy.

  • Type: int
  • Default: 0
  • Valid Values: [0,…]
  • Importance: high
http.proxy.user

The username to be used when authenticating with the http proxy.

  • Type: string
  • Default: “”
  • Importance: high
http.proxy.password

The password to be used when authenticating with the http proxy.

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

Authorization

auth.type

Authentication type of the endpoint. Valid values are NONE, BASIC, OAUTH2 (Client Credentials grant type only).

  • Type: string
  • Default: NONE
  • Importance: high
connection.user

The username to be used with an endpoint requiring authentication.

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

The password to be used with an endpoint requiring authentication.

  • Type: password
  • Default: [hidden]
  • Importance: high
oauth2.token.url

The URL to be used for fetching OAUTH2 token. Client Credentials is the only supported grant type.

  • Type: string
  • Default: “”
  • Importance: high
oauth2.client.id

The client id used when fetching OAUTH2 token

  • Type: string
  • Default: “”
  • Importance: high
oauth2.client.secret

The client secret used when fetching OAUTH2 token

  • Type: password
  • Default: [hidden]
  • Importance: high
oauth2.token.property

The name of the property containing the OAUTH2 token returned by the http proxy. Default value is access_token.

  • Type: string
  • Default: access_token
  • Importance: high
oauth2.client.auth.mode

Specifies how to encode client_id and client_secret in the OAuth2 authorization request. If set to ‘header’, the credentials are encoded as an 'Authorization: Basic <base-64 encoded client_id:client_secret>' HTTP header. If set to ‘url’, then client_id and client_secret are sent as URL encoded parameters.

  • Type: string
  • Default: header
  • Valid Values: one of [header, url]
  • Importance: low
  • Since: v1.0.3
oauth2.client.scope

The scope used when fetching OAuth2 token.

  • Type: string
  • Default: any
  • Importance: low
  • Since: v1.0.3

Retries

max.retries

The maximum number of times to retry on errors before failing the task.

  • Type: int
  • Default: 10
  • Valid Values: [0,…]
  • Importance: medium
retry.backoff.ms

The time in milliseconds to wait following an error before a retry attempt is made.

  • Type: int
  • Default: 3000
  • Valid Values: [0,…]
  • Importance: medium

Regex

regex.patterns

Character separated regex patterns to match for replacement in the destination messages.

  • Type: string
  • Default: “”
  • Importance: low
regex.replacements

Character separated regex replacements to use with the patterns in regex.patterns. ${key} and ${topic} can be used here.

  • Type: string
  • Default: “”
  • Importance: low
regex.separator

Separator character used in regex.patterns and regex.replacements property.

  • Type: string
  • Default: ~
  • Importance: high

Batching

batch.key.pattern

Pattern used to build the key for a given batch. ${key} and ${topic} can be used to include message attributes here.

  • Type: string
  • Default: someKey
  • Importance: high
batch.max.size

The number of records accumulated in a batch before the HTTP API is invoked.

  • Type: int
  • Default: 1
  • Importance: high
batch.prefix

Prefix added to record batches. This is applied once at the beginning of the batch of records.

  • Type: string
  • Default: “”
  • Importance: high
batch.suffix

Suffix added to record batches. This is applied once at the end of the batch of records.

  • Type: string
  • Default: “”
  • Importance: high
batch.seperator

Separator for records in a batch.

  • Type: string
  • Default: ,
  • Importance: high

Security

https.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
https.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
https.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
https.ssl.truststore.location

The location of the trust store file.

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

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

  • Type: password
  • Default: null
  • Importance: high
https.ssl.enabled.protocols

The list of protocols enabled for SSL connections.

  • Type: list
  • Default: TLSv1.2,TLSv1.1,TLSv1
  • Importance: medium
https.ssl.keystore.type

The file format of the key store file. This is optional for client.

  • Type: string
  • Default: JKS
  • Importance: medium
https.ssl.protocol

The SSL protocol used to generate the SSLContext. Default setting is TLS, which is fine for most cases. Allowed values in recent JVMs are TLS, TLSv1.1 and TLSv1.2. SSL, SSLv2 and SSLv3 may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities.

  • Type: string
  • Default: TLS
  • Importance: medium
https.ssl.provider

The name of the security provider used for SSL connections. Default value is the default security provider of the JVM.

  • Type: string
  • Default: null
  • Importance: medium
https.ssl.truststore.type

The file format of the trust store file.

  • Type: string
  • Default: JKS
  • Importance: medium
https.ssl.cipher.suites

A list of cipher suites. This is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol. By default all the available cipher suites are supported.

  • Type: list
  • Default: null
  • Importance: low
https.ssl.endpoint.identification.algorithm

The endpoint identification algorithm to validate server hostname using server certificate.

  • Type: string
  • Default: https
  • Importance: low
https.ssl.keymanager.algorithm

The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine.

  • Type: string
  • Default: SunX509
  • Importance: low
https.ssl.secure.random.implementation

The SecureRandom PRNG implementation to use for SSL cryptography operations.

  • Type: string
  • Default: null
  • Importance: low
https.ssl.trustmanager.algorithm

The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine.

  • Type: string
  • Default: PKIX
  • Importance: low

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 <code>host1:port1,host2:port2,…</code>. Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not 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

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 an 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.