.. _kinesis-source-connector-config:


Configuration properties
------------------------

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

.. codewithvars:: properties

    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
  
.. _kinesis-source-connector-license-config:

|cp| 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
----------------------------

.. include:: ../includes/security-info.rst

.. include:: ../includes/platform-license.rst

.. include:: ../includes/security-configs.rst

.. _kinesis-source-license-topic-configuration:

.. include:: ../includes/platform-license-detail.rst

.. include:: ../includes/overriding-default-config-properties.rst