|
| 1 | +# AWS Shared Configuration File Loader |
| 2 | + |
| 3 | +This module provides a function that reads from AWS SDK configuration files and |
| 4 | +returns a promise that will resolve with a hash of the parsed contents of the |
| 5 | +AWS credentials file and of the AWS config file. Given the [sample |
| 6 | +files](#sample-files) below, the promise returned by `loadSharedConfigFiles` |
| 7 | +would resolve with: |
| 8 | + |
| 9 | +```javascript |
| 10 | +{ |
| 11 | + configFile: { |
| 12 | + 'default': { |
| 13 | + aws_access_key_id: 'foo', |
| 14 | + aws_secret_access_key: 'bar', |
| 15 | + }, |
| 16 | + dev: { |
| 17 | + aws_access_key_id: 'foo1', |
| 18 | + aws_secret_access_key: 'bar1', |
| 19 | + }, |
| 20 | + prod: { |
| 21 | + aws_access_key_id: 'foo2', |
| 22 | + aws_secret_access_key: 'bar2', |
| 23 | + }, |
| 24 | + 'testing host': { |
| 25 | + aws_access_key_id: 'foo4', |
| 26 | + aws_secret_access_key: 'bar4', |
| 27 | + } |
| 28 | + }, |
| 29 | + credentialsFile: { |
| 30 | + 'default': { |
| 31 | + aws_access_key_id: 'foo', |
| 32 | + aws_secret_access_key: 'bar', |
| 33 | + }, |
| 34 | + dev: { |
| 35 | + aws_access_key_id: 'foo1', |
| 36 | + aws_secret_access_key: 'bar1', |
| 37 | + }, |
| 38 | + prod: { |
| 39 | + aws_access_key_id: 'foo2', |
| 40 | + aws_secret_access_key: 'bar2', |
| 41 | + } |
| 42 | + }, |
| 43 | +} |
| 44 | +``` |
| 45 | + |
| 46 | +If a file is not found, its key (`configFile` or `credentialsFile`) will instead |
| 47 | +have a value of an empty object. |
| 48 | + |
| 49 | +## Supported configuration |
| 50 | + |
| 51 | +You may customize how the files are loaded by providing an options hash to the |
| 52 | +`loadSharedConfigFiles` function. The following options are supported: |
| 53 | + |
| 54 | + * `filepath` - The path to the shared credentials file. If not specified, the |
| 55 | + provider will use the value in the `AWS_SHARED_CREDENTIALS_FILE` environment |
| 56 | + variable or a default of `~/.aws/credentials`. |
| 57 | + * `configFilepath` - The path to the shared config file. If not specified, the |
| 58 | + provider will use the value in the `AWS_CONFIG_FILE` environment variable or a |
| 59 | + default of `~/.aws/config`. |
| 60 | + |
| 61 | +## Sample files |
| 62 | + |
| 63 | +### `~/.aws/credentials` |
| 64 | +```ini |
| 65 | +[default] |
| 66 | +aws_access_key_id=foo |
| 67 | +aws_secret_access_key=bar |
| 68 | + |
| 69 | +[dev] |
| 70 | +aws_access_key_id=foo2 |
| 71 | +aws_secret_access_key=bar2 |
| 72 | + |
| 73 | +[prod] |
| 74 | +aws_access_key_id=foo3 |
| 75 | +aws_secret_access_key=bar3 |
| 76 | +``` |
| 77 | + |
| 78 | +### `~/.aws/config` |
| 79 | +```ini |
| 80 | +[default] |
| 81 | +aws_access_key_id=foo |
| 82 | +aws_secret_access_key=bar |
| 83 | + |
| 84 | +[profile dev] |
| 85 | +aws_access_key_id=foo2 |
| 86 | +aws_secret_access_key=bar2 |
| 87 | + |
| 88 | +[profile prod] |
| 89 | +aws_access_key_id=foo3 |
| 90 | +aws_secret_access_key=bar3 |
| 91 | + |
| 92 | +[profile "testing host"] |
| 93 | +aws_access_key_id=foo4 |
| 94 | +aws_secret_access_key=bar4 |
| 95 | +``` |
0 commit comments