Skip to content

Kinesis

Install

See the Install guide for the full setup, including Windows PowerShell.

curl -fsSL https://install.skippr.io/install.sh | shClick to copy

Consumes records from an Amazon Kinesis stream.

Configuration

yaml
source:
  kind: kinesis
  stream_name: my-stream
  region: us-east-1
FieldDefaultDescription
stream_name(required)Kinesis stream name
regionAWS region
endpoint_urlCustom Kinesis endpoint URL
modeConsumption mode such as stream or batch

CLI

bash
skippr connect source kinesis \
  --stream-name my-stream \
  --region us-east-1 \
  --endpoint-url http://localhost:4566 \
  --mode stream
FlagDescription
--stream-nameKinesis stream name
--regionAWS region
--endpoint-urlCustom Kinesis endpoint URL
--modeConsumption mode

Authentication

Authentication uses the AWS default credential chain.

  • AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
  • IAM roles, instance profiles, or task roles
  • AWS SSO or shared config profiles

Permissions or Network Requirements

The AWS principal needs kinesis:DescribeStreamSummary, kinesis:GetShardIterator, and kinesis:GetRecords on the selected stream. The runner must also be able to reach the regional Kinesis endpoint.

Troubleshooting

SymptomFix
AccessDenied or stream errorsVerify the AWS credential chain, stream name, region, and Kinesis permissions.
no records arrivingCheck that producers are writing to the expected stream and shard activity is present.

Next steps

Install

See the Install guide for the full setup, including Windows PowerShell.

curl -fsSL https://install.skippr.io/install.sh | shClick to copy