https://github.com/takehilo/aws-creds-loader
AWS credentials loader for cli apps
https://github.com/takehilo/aws-creds-loader
aws cli config es6 javascript nodejs
Last synced: 3 months ago
JSON representation
AWS credentials loader for cli apps
- Host: GitHub
- URL: https://github.com/takehilo/aws-creds-loader
- Owner: takehilo
- License: mit
- Created: 2017-12-25T06:55:58.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-25T09:11:55.000Z (over 8 years ago)
- Last Synced: 2025-09-16T21:06:01.699Z (10 months ago)
- Topics: aws, cli, config, es6, javascript, nodejs
- Language: JavaScript
- Size: 44.9 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# aws-creds-loader
[](https://travis-ci.org/takehilo/aws-creds-loader)
[](https://coveralls.io/github/takehilo/aws-creds-loader?branch=add-coveralls-script)
This library supports CLI apps to load credentials and region.
## Installation
```
$ npm install aws-creds-loader
```
## Usage
By default, aws-creds-loader reads `~/.aws/credentials` and `~/.aws/config` which are for [AWS CLI](http://docs.aws.amazon.com/cli/latest/userguide/cli-config-files.html).
`~/.aws/credentials`
```
[default]
aws_access_key_id=AKIAIOSFODNN7EXAMPLE
aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
[admin]
aws_access_key_id=AKIAI44QH8DHBEXAMPLE
aws_secret_access_key=je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY
```
`~/.aws/config`
```
[default]
region=ap-northeast-1
[profile admin]
region=us-east-1
```
```js
const awsCredsLoader = require('aws-creds-loader')
const AWS = require('aws-sdk')
awsCredsLoader(AWS)
AWS.config.credentials.accessKeyId // AKIAIOSFODNN7EXAMPLE
AWS.config.credentials.secretAccessKey // wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
AWS.config.region // ap-northeast-1
```
It Supports profile option.
```js
awsCredsLoader(AWS, {profile: 'admin'})
AWS.config.credentials.accessKeyId // AKIAI44QH8DHBEXAMPLE
AWS.config.credentials.secretAccessKey // je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY
AWS.config.region // us-east-1
```
It also supports environment variables.
- AWS_ACCESS_KEY_ID
- AWS_SECRET_ACCESS_KEY
- AWS_DEFAULT_REGION
## API
### awsCredsLoader(AWS, options)
#### AWS
[`aws-sdk`](https://www.npmjs.com/package/aws-sdk) Object.
### options
#### options.profile
Profile name in your credentials/config file.
#### options.credentialsFile
Path to credentials file.
Defaults to `~/.aws/credentials`.
#### options.configFile
Path to config file.
Defaults to `~/.aws/config`.