Amazon Kinesis

target-kinesis (prontopro variant)

Real-time Streaming Platform

The target-kinesis loader sends data into Amazon Kinesis after it was pulled from a source using an extractor

Available Variants

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the target-kinesis loader to your project using
    meltano add
    :
  2. meltano add loader target-kinesis
  3. Configure the target-kinesis settings using
    meltano config
    :
  4. meltano config target-kinesis set --interactive

Next steps

If you run into any issues, learn how to get help.

Capabilities

This plugin currently has no capabilities defined. If you know the capabilities required by this plugin, please contribute!

Settings

The target-kinesis settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using

meltano config
with the list subcommand:

meltano config target-kinesis list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Stream Name (stream_name)

  • Environment variable: TARGET_KINESIS_STREAM_NAME

The name of the Kinesis stream to write to.


Configure this setting directly using the following Meltano command:

meltano config target-kinesis set stream_name [value]

AWS S3 Access Key ID (aws_access_key_id)

  • Environment variable: TARGET_KINESIS_AWS_ACCESS_KEY_ID

S3 Access Key Id. If not provided, aws_profile or AWS_ACCESS_KEY_ID environment variable will be used.


Configure this setting directly using the following Meltano command:

meltano config target-kinesis set aws_access_key_id [value]

AWS S3 Secret Access Key (aws_secret_access_key)

  • Environment variable: TARGET_KINESIS_AWS_SECRET_ACCESS_KEY

S3 Secret Access Key. If not provided, aws_profile or AWS_ACCESS_KEY_ID environment variable will be used.


Configure this setting directly using the following Meltano command:

meltano config target-kinesis set aws_secret_access_key [value]

AWS Region (region)

  • Environment variable: TARGET_KINESIS_REGION

The AWS region to use i.e. us-east-2.


Configure this setting directly using the following Meltano command:

meltano config target-kinesis set region [value]

Is Firehouse (is_firehose)

  • Environment variable: TARGET_KINESIS_IS_FIREHOSE

(Default False) Whether to user a Firehouse client or not.


Configure this setting directly using the following Meltano command:

meltano config target-kinesis set is_firehose [value]

Record Chunks (record_chunks)

  • Environment variable: TARGET_KINESIS_RECORD_CHUNKS

(Default - 10) The max number of records per chunk.


Configure this setting directly using the following Meltano command:

meltano config target-kinesis set record_chunks [value]

Data Chunks (data_chunks)

  • Environment variable: TARGET_KINESIS_DATA_CHUNKS

(Default - 1000) The max size of data per chunk.


Configure this setting directly using the following Meltano command:

meltano config target-kinesis set data_chunks [value]

Partition Key (partition_key)

  • Environment variable: TARGET_KINESIS_PARTITION_KEY

(Default - id) The partition key to use when writing to Kinesis.


Configure this setting directly using the following Meltano command:

meltano config target-kinesis set partition_key [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the target-kinesis loader to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add loader target-kinesis

Maintenance Status

  • Maintenance Status

Repo

https://github.com/ProntoPro/target-kinesis
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • ProntoPro

Keywords

  • api