The @aws-sdk/credential-provider-ini package is a module that allows Node.js developers to load AWS credentials from INI-formatted files, such as the ones created by the AWS CLI. This package is part of the AWS SDK for JavaScript (v3) and is used to retrieve AWS credentials from local configuration files, enabling developers to authenticate AWS SDK calls.

What are @aws-sdk/credential-provider-ini's main functionalities?

Loading credentials from a shared INI file

This feature allows developers to load AWS credentials from a shared INI file, typically located at `~/.aws/credentials`. The `fromIni` function reads the file and returns the credentials for the default profile or a specified profile.

const { fromIni } = require('@aws-sdk/credential-provider-ini');
const credentials = fromIni();

Specifying a custom profile

Developers can specify a custom profile to load credentials for a specific AWS account or role. This is useful when working with multiple AWS accounts or when different permissions are needed.

const { fromIni } = require('@aws-sdk/credential-provider-ini');
const credentials = fromIni({ profile: 'myCustomProfile' });

Assuming a role with MFA

This feature supports assuming an IAM role that requires Multi-Factor Authentication (MFA). The `mfaCodeProvider` is a function that returns the MFA code, which is then used to assume the role.

const { fromIni } = require('@aws-sdk/credential-provider-ini');
const credentials = fromIni({
  profile: 'myRoleProfile',
  mfaCodeProvider: async () => '123456', // Replace with actual MFA code provider
});

Other packages similar to @aws-sdk/credential-provider-ini

Changelog

Source

3.348.0 (2023-06-07)

Bug Fixes

middleware-websocket: update eventStreamHandler to use MessageSigner (#4803) (d8317fe)
node-http-handler: begin socket timeout countdown before socket event (#4804) (f5ce61a)

Features

client-cloudformation: AWS CloudFormation StackSets is updating the deployment experience for all stackset operations to skip suspended AWS accounts during deployments. StackSets will skip target AWS accounts that are suspended and set the Detailed Status of the corresponding stack instances as SKIPPED_SUSPENDED_ACCOUNT (83514db)
client-cloudwatch-logs: This change adds support for account level data protection policies using 3 new APIs, PutAccountPolicy, DeleteAccountPolicy and DescribeAccountPolicy. DescribeLogGroup API has been modified to indicate if account level policy is applied to the LogGroup via "inheritedProperties" list in the response. (d6b0058)
client-customer-profiles: This release introduces event stream related APIs. (5263022)
client-emr-containers: EMR on EKS adds support for log rotation of Spark container logs with EMR-6.11.0 onwards, to the StartJobRun API. (9a4e143)
client-iotdeviceadvisor: AWS IoT Core Device Advisor now supports new Qualification Suite test case list. With this update, customers can more easily create new qualification test suite with an empty rootGroup input. (1f9abd0)

Readme

Source