mapbox / mapbox/kine

Support passing credentials to Kine as an alternative to passing Access Keys directly

Open
#42 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
18
Forks
8
PR merge metrics
No merged PRs in 30d

Description

We should add support for a `credentials` option in the Kine constructor options so that instead of having to specify the actual AWS Access Key and Secret Key (if you don't want to use the defaults), you can use any of the various Credential Providers/subclasses (see [here](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Credentials.html)). This allows you to do useful things like use [TemporaryCredentials](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/TemporaryCredentials.html) from an assumed role that will automatically refresh as needed.

Of note, if #41 is implemented, we should also support that here by way of supporting separate `kinesisCredentials` and `dynamodbCredentials` as well.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the Kine constructor options and trace how the AWS Access Key and Secret Key are currently passed to Kinesis and DynamoDB. Check the AWS Credentials and TemporaryCredentials documentation, then verify that credential providers can be supplied through the new option without breaking existing key-based configuration; consider separate service credentials only if issue #41 is implemented.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, javascript
Domain
backend, cloud
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.