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.kinesis.KinesisSourceConnector

Connector-specific configuration properties are described below.

Kinesis¶

aws.access.key.id

The Amazon Access Key that will be used to connect to Kinesis with.

Type: String
Importance: High

aws.secret.key.id

The Amazon Secret Key that will be used to connect to Kinesis with.

Type: Password
Importance: High

kinesis.stream

The Kinesis stream to read from.

Type: String
Importance: High

kinesis.shard.id

The shard of the Kinesis stream to read from. This is a regex which can be used to read all of the shards in the stream.

Type: String
Importance: High
Default Value: .*

kinesis.base.url

Kinesis endpoint URL which overrides the signing region. Can be used to connect to VPC endpoints and non standard endpoints.

Type: String
Importance: Low
Default Value: “” (Empty String)

kinesis.credentials.provider.class

Credentials provider or provider chain to use for authentication to AWS. By default the connector uses 'DefaultAWSCredentialsProviderChain'.

Type: Class
Importance: Low
Default Value: DefaultAWSCredentialsProviderChain.class

kinesis.empty.records.backoff.ms

The number of milliseconds to backoff when the stream is empty.

Type: Long
Importance: Medium
Default Value: 5000
Valid Values: [500,…]

kinesis.position

The position in the stream to reset to if no offsets are stored.

Type: String
Importance: Medium
Default Value: TRIM_HORIZON
Valid Values: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP

kinesis.record.limit

The number of records to read in each poll of the Kinesis shard.

Type: Int
Importance: Medium
Default Value: 500
Valid Values: [1,…,10000]

kinesis.region

The AWS region for the Kinesis stream.

Type: String
Importance: Medium
Default Value: US_EAST_1
Valid Values: GovCloud, US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, EU_WEST_1, EU_WEST_2, EU_WEST_3, EU_CENTRAL_1, AP_SOUTH_1, AP_SOUTHEAST_1, AP_SOUTHEAST_2, AP_NORTHEAST_1, AP_NORTHEAST_2, SA_EAST_1, CN_NORTH_1, CN_NORTHWEST_1, CA_CENTRAL_1

kinesis.throughput.exceeded.backoff.ms

The number of milliseconds to backoff when a throughput exceeded exception is thrown.

Type: Long
Importance: Medium
Default Value: 10000
Valid Values: [500,…]

General¶

kafka.topic

The kafka topic to write the data to.

Type: String
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 <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.