Important

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

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

Connector-specific configuration properties are described below.

Kinesis Details

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
  • Default: .*
  • Valid Values: valid Java regular expression pattern
  • Importance: high
kinesis.position

The position in the stream to reset to if no offsets are stored. Note: AFTER_SEQUENCE_NUMBER and AT_SEQUENCE_NUMBER are currently not supported values.

  • Type: string
  • Default: TRIM_HORIZON
  • Valid Values: one of [TRIM_HORIZON, LATEST, AT_TIMESTAMP]
  • Importance: low
kinesis.shard.timestamp

Timestamp (the Unix epoch date with precision in milliseconds) after which to start reading records from. To be used only in combination with kinesis.position=AT_TIMESTAMP. Allowed formats: yyyy-MM-dd’T’HH:mm:ss.SSSXXX or epoch time in ms. Note: this will apply to every specified shard in the stream.

  • Type: string
  • Default: “”
  • Valid Values: either blank, or timestamp in one of these formats: yyyy-MM-dd, yyyy-MM-dd'T'HH:mm:SS, yyyy-'W'w-6EX, yyyy-MM-dd'T'HH:mm:SSV, or Matches regex ([1-9][0-9]|0)*
  • Importance: low
kinesis.region

The AWS region for the Kinesis stream.

  • Type: string
  • Default: US_EAST_1
  • Valid Values: either one of [eu-west-3, ap-south-1, eu-west-2, eu-west-1, ap-northeast-2, ap-northeast-1, sa-east-1, ca-central-1, cn-north-1, us-gov-west-1, ap-southeast-1, ap-southeast-2, eu-central-1, us-east-1, us-east-2, us-west-1, cn-northwest-1, us-west-2], or one of [GovCloud, CN_NORTH_1, SA_EAST_1, CN_NORTHWEST_1, AP_NORTHEAST_2, AP_NORTHEAST_1, CA_CENTRAL_1, AP_SOUTH_1, US_WEST_2, US_WEST_1, US_EAST_2, US_EAST_1, EU_CENTRAL_1, AP_SOUTHEAST_1, AP_SOUTHEAST_2, EU_WEST_3, EU_WEST_1, EU_WEST_2]
  • Importance: medium
kinesis.base.url

The property kinesis.base.url can be used to specify a Kinesis endpoint. For example, if Kinesis is running on port 4567 on your localhost, you may specify http://localhost:4567.

Examples of endpoints can be found on: https://docs.aws.amazon.com/general/latest/gr/rande.html#ak_region.

More information on using endpoints: https://docs.aws.amazon.com/streams/latest/dev/vpc.html

  • Type: string
  • Default: “”
  • Valid Values: either blank or null, or URI with one of these schemes: ‘http’, ‘https’
  • Importance: low

AWS Credentials

aws.access.key.id

The AWS access key that will be used to connect to Kinesis with.

  • Type: string
  • Default: “”
  • Importance: high
aws.secret.key.id

The AWS secret key that will be used to connect to Kinesis with.

  • Type: password
  • Default: null
  • Importance: high
kinesis.credentials.provider.class

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

  • Type: class
  • Default: com.amazonaws.auth.DefaultAWSCredentialsProviderChain
  • Valid Values: Any class implementing: interface com.amazonaws.auth.AWSCredentialsProvider
  • Importance: low

Connector Details

kafka.topic

The kafka topic to write the data to.

  • Type: string
  • Valid Values: Valid topic names contain 1-249 ASCII alphanumeric, +, ., _ and - characters
  • Importance: high
kinesis.record.limit

The maximum number of records to read in per poll of a Kinesis shard.

  • Type: int
  • Default: 500
  • Valid Values: [1,…,10000]
  • Importance: medium
kinesis.empty.records.backoff.ms

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

  • Type: long
  • Default: 5000
  • Valid Values: [1,…,9223372036854775807]
  • Importance: low
kinesis.throughput.exceeded.backoff.ms

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

  • Type: long
  • Default: 10000
  • Valid Values: [1,…,9223372036854775807]
  • Importance: low

Proxy

kinesis.proxy.url

Proxy Server URL. This property is meant to be used only if you need to access Kinesis through an HTTP/HTTPS proxy.

  • Type: string
  • Default: “”
  • Valid Values: either blank or null, or URI with one of these schemes: ‘http’, ‘https’
  • Importance: low
kinesis.proxy.username

Proxy Username. This property is meant to be used only if you need to access Kinesis through an HTTP/HTTPS proxy. Using kinesis.proxy.username instead of embedding the username and password in kinesis.proxy.url allows the password to be hidden in the logs.

  • Type: string
  • Default: “”
  • Importance: low
kinesis.proxy.password

Proxy Password. This property is meant to be used only if you need to access Kinesis through an HTTP/HTTPS proxy. Using kinesis.proxy.password instead of embedding the username and password in kinesis.proxy.password allows the password to be hidden in the logs.

  • Type: password
  • Default: [hidden]
  • Importance: low
kinesis.non.proxy.hosts

Non Proxy Hosts. This property is meant to be used for defining non proxy hosts.For example, this can be configured as localhost, 127.0.0.1, host-address-1 or localhost|127.0.0.1|host-address-1.

  • Type: list
  • Default: “”
  • 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..

License topic ACLs

The _confluent-command topic contains the license that corresponds to the license key supplied through the confluent.license property. It is created by default. Connectors that access this topic require the following ACLs configured:

  • CREATE and DESCRIBE on the resource cluster, if the connector needs to create the topic.
  • DESCRIBE, READ, and WRITE on the _confluent-command topic.

You can provide access either individually for each principal that will use the license or use a wildcard entry to allow all clients. The following examples show commands that you can use to configure ACLs for the resource cluster and _confluent-command topic.

  1. Set a CREATE and DESCRIBE ACL on the resource cluster:

    kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \
--add --allow-principal User:<principal> \
--operation CREATE --operation DESCRIBE --cluster

  2. Set a DESCRIBE, READ, and WRITE ACL on the _confluent-command topic:

    kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \
--add --allow-principal User:<principal> \
--operation DESCRIBE --operation READ --operation WRITE --topic _confluent-command

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.