@aws-sdk/shared-ini-file-loader
Advanced tools
[](https://www.npmjs.com/package/@aws-sdk/shared-ini-file-loader) [](https://www.npmj
Package description
@aws-sdk/shared-ini-file-loader is a package from the AWS SDK for JavaScript that provides utilities for loading and parsing AWS credentials and configuration from INI files. This is particularly useful for managing multiple AWS profiles and credentials in a standardized way.
Load AWS Credentials from INI File
This feature allows you to load AWS credentials from the shared INI file. The `loadSharedConfigFiles` function reads the credentials and configuration files and returns their contents.
const { loadSharedConfigFiles } = require('@aws-sdk/shared-ini-file-loader');
async function loadCredentials() {
const { credentialsFile } = await loadSharedConfigFiles();
console.log(credentialsFile);
}
loadCredentials();Load AWS Configurations from INI File
This feature allows you to load AWS configurations from the shared INI file. The `loadSharedConfigFiles` function reads the configuration file and returns its contents.
const { loadSharedConfigFiles } = require('@aws-sdk/shared-ini-file-loader');
async function loadConfig() {
const { configFile } = await loadSharedConfigFiles();
console.log(configFile);
}
loadConfig();Parse Specific Profile
This feature allows you to parse and load a specific AWS profile from the shared INI files. The `parseKnownFiles` function can be used to specify which profile to load.
const { parseKnownFiles } = require('@aws-sdk/shared-ini-file-loader');
async function loadProfile(profileName) {
const { credentialsFile, configFile } = await parseKnownFiles({ profile: profileName });
console.log(credentialsFile[profileName], configFile[profileName]);
}
loadProfile('my-profile');The `aws-sdk` package is the official AWS SDK for JavaScript. It provides a comprehensive set of tools for interacting with AWS services, including loading credentials and configurations. However, it is a much larger package with a broader scope compared to `@aws-sdk/shared-ini-file-loader`.
The `aws-cred-loader` package is a lightweight utility for loading AWS credentials from various sources, including INI files. It offers similar functionality to `@aws-sdk/shared-ini-file-loader` but is more focused on credentials loading rather than a full configuration management.
The `aws-profile-loader` package is designed to load AWS profiles from INI files. It provides similar functionality to `@aws-sdk/shared-ini-file-loader` but is more specialized in handling multiple profiles and their configurations.
Changelog
3.374.0 (2023-07-20)
Readme
This module provides a function that reads from AWS SDK configuration files and
returns a promise that will resolve with a hash of the parsed contents of the
AWS credentials file and of the AWS config file. Given the sample
files below, the promise returned by loadSharedConfigFiles
would resolve with:
{
configFile: {
'default': {
aws_access_key_id: 'foo',
aws_secret_access_key: 'bar',
},
dev: {
aws_access_key_id: 'foo1',
aws_secret_access_key: 'bar1',
},
prod: {
aws_access_key_id: 'foo2',
aws_secret_access_key: 'bar2',
},
'testing host': {
aws_access_key_id: 'foo4',
aws_secret_access_key: 'bar4',
}
},
credentialsFile: {
'default': {
aws_access_key_id: 'foo',
aws_secret_access_key: 'bar',
},
dev: {
aws_access_key_id: 'foo1',
aws_secret_access_key: 'bar1',
},
prod: {
aws_access_key_id: 'foo2',
aws_secret_access_key: 'bar2',
}
},
}
If a file is not found, its key (configFile or credentialsFile) will instead
have a value of an empty object.
You may customize how the files are loaded by providing an options hash to the
loadSharedConfigFiles function. The following options are supported:
filepath - The path to the shared credentials file. If not specified, the
provider will use the value in the AWS_SHARED_CREDENTIALS_FILE environment
variable or a default of ~/.aws/credentials.configFilepath - The path to the shared config file. If not specified, the
provider will use the value in the AWS_CONFIG_FILE environment variable or a
default of ~/.aws/config.ignoreCache - The provider will normally cache the contents of the files it
loads. This option will force the provider to reload the files from disk.
Defaults to false.~/.aws/credentials[default]
aws_access_key_id=foo
aws_secret_access_key=bar
[dev]
aws_access_key_id=foo2
aws_secret_access_key=bar2
[prod]
aws_access_key_id=foo3
aws_secret_access_key=bar3
~/.aws/config[default]
aws_access_key_id=foo
aws_secret_access_key=bar
[profile dev]
aws_access_key_id=foo2
aws_secret_access_key=bar2
[profile prod]
aws_access_key_id=foo3
aws_secret_access_key=bar3
[profile "testing host"]
aws_access_key_id=foo4
aws_secret_access_key=bar4
FAQs
[](https://www.npmjs.com/package/@aws-sdk/shared-ini-file-loader) [](https://www.npmj
The npm package @aws-sdk/shared-ini-file-loader receives a total of 2,427,944 weekly downloads. As such, @aws-sdk/shared-ini-file-loader popularity was classified as popular.
We found that @aws-sdk/shared-ini-file-loader demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.
Product
Check out what's new at Socket with our Product Changelog. It tracks all public-facing updates, improvements, and fixes so you can take full advantage of our features.