Important

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

Kinesis Source Connector Configuration Options

The Kinesis Source Connector Connector can be configured using a variety of configuration properties.

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