Skip to main content
Version: 3.3.x

Kinesis source connector

note

You can download all the Pulsar connectors on download page.

The Kinesis source connector pulls data from Amazon Kinesis and persists data into Pulsar.

This connector uses the Kinesis Consumer Library (KCL) to do the actual consumption of messages. The KCL uses DynamoDB to track the state of consumers.

note

Currently, the Kinesis source connector only supports raw messages. If you use KMS encrypted messages, the encrypted messages are sent to downstream. This connector will support decrypting messages in future releases.

Configuration

The configuration of the Kinesis source connector has the following properties.

Property

NameTypeRequiredDefaultDescription
initialPositionInStreamInitialPositionInStreamfalseLATESTThe position where the connector starts from.

Below are the available options:

  • AT_TIMESTAMP: start from the record at or after the specified timestamp.

  • LATEST: start after the most recent data record.

  • TRIM_HORIZON: start from the oldest available data record.
  • startAtTimeDatefalse" " (empty string)If set to AT_TIMESTAMP, it specifies the point in time to start consumption.
    applicationNameStringfalsePulsar IO connectorThe name of the Amazon Kinesis application.

    By default, the application name is included in the user agent string used to make AWS requests. This can assist with troubleshooting, for example, distinguish requests made by separate connector instances.
    checkpointIntervallongfalse60000The frequency of the Kinesis stream checkpoint in milliseconds.
    backoffTimelongfalse3000The amount of time to delay between requests when the connector encounters a throttling exception from AWS Kinesis in milliseconds.
    numRetriesintfalse3The number of re-attempts when the connector encounters an exception while trying to set a checkpoint.
    receiveQueueSizeintfalse1000The maximum number of AWS records that can be buffered inside the connector.

    Once the receiveQueueSize is reached, the connector does not consume any messages from Kinesis until some messages in the queue are successfully consumed.
    dynamoEndpointStringfalse" " (empty string)The Dynamo end-point URL, which can be found at here.
    cloudwatchEndpointStringfalse" " (empty string)The Cloudwatch end-point URL, which can be found at here.
    useEnhancedFanOutbooleanfalsetrueIf set to true, it uses Kinesis enhanced fan-out.

    If set to false, it uses polling.
    awsEndpointStringfalse" " (empty string)The Kinesis end-point URL, which can be found at here.
    awsRegionStringfalse" " (empty string)The AWS region.

    Example
    us-west-1, us-west-2
    awsKinesisStreamNameStringtrue" " (empty string)The Kinesis stream name.
    awsCredentialPluginNameStringfalse" " (empty string)The fully-qualified class name of implementation of AwsCredentialProviderPlugin.

    awsCredentialProviderPlugin has the following built-in plugs:

  • org.apache.pulsar.io.kinesis.AwsDefaultProviderChainPlugin:
    this plugin uses the default AWS provider chain.
    For more information, see using the default credential provider chain.

  • org.apache.pulsar.io.kinesis.STSAssumeRoleProviderPlugin:
    this plugin takes a configuration via the awsCredentialPluginParam that describes a role to assume when running the KCL.
    JSON configuration example
    {"roleArn": "arn...", "roleSessionName": "name"}

    awsCredentialPluginName is a factory class which creates an AWSCredentialsProvider that is used by Kinesis sink.

    If awsCredentialPluginName set to empty, the Kinesis sink creates a default AWSCredentialsProvider which accepts json-map of credentials in awsCredentialPluginParam.
  • awsCredentialPluginParamStringfalse" " (empty string)The JSON parameter to initialize awsCredentialsProviderPlugin.

    Example

    Before using the Kinesis source connector, you need to create a configuration file through one of the following methods.

    • JSON

      {
      "configs": {
      "awsEndpoint": "https://some.endpoint.aws",
      "awsRegion": "us-east-1",
      "awsKinesisStreamName": "my-stream",
      "awsCredentialPluginParam": "{\"accessKey\":\"myKey\",\"secretKey\":\"my-Secret\"}",
      "applicationName": "My test application",
      "checkpointInterval": "30000",
      "backoffTime": "4000",
      "numRetries": "3",
      "receiveQueueSize": 2000,
      "initialPositionInStream": "TRIM_HORIZON",
      "startAtTime": "2019-03-05T19:28:58.000Z"
      }
      }
    • YAML

      configs:
      awsEndpoint: "https://some.endpoint.aws"
      awsRegion: "us-east-1"
      awsKinesisStreamName: "my-stream"
      awsCredentialPluginParam: "{\"accessKey\":\"myKey\",\"secretKey\":\"my-Secret\"}"
      applicationName: "My test application"
      checkpointInterval: 30000
      backoffTime: 4000
      numRetries: 3
      receiveQueueSize: 2000
      initialPositionInStream: "TRIM_HORIZON"
      startAtTime: "2019-03-05T19:28:58.000Z"