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.587.0 (2024-05-30)

Bug Fixes

credentials-provider-ini: include general http provider when sourcing EcsContainer credentials (#6132) (8cdaf0a)

Features

client-acm: add v2 smoke tests and smithy smokeTests trait for SDK testing. (c87de6a)
client-bedrock-agent: With this release, Knowledge bases for Bedrock adds support for Titan Text Embedding v2. (c2f93e1)
client-bedrock-runtime: This release adds Converse and ConverseStream APIs to Bedrock Runtime (512d901)
client-cloudtrail: CloudTrail Lake returns PartitionKeys in the GetEventDataStore API response. Events are grouped into partitions based on these keys for better query performance. For example, the calendarday key groups events by day, while combining the calendarday key with the hour key groups them by day and hour. (88273ba)
client-connect: Adding associatedQueueIds as a SearchCriteria and response field to the SearchRoutingProfiles API (b46048a)
client-emr-serverless: The release adds support for spark structured streaming. (572bc93)
client-sagemaker: Adds Model Card information as a new component to Model Package. Autopilot launches algorithm selection for TimeSeries modality to generate AutoML candidates per algorithm. (393afc7)
clients: update client endpoints as of 2024-05-30 (d131ac0)

Readme

Source

@aws-sdk/credential-provider-ini

An internal package

Usage

You probably shouldn't, at least directly. Please use @aws-sdk/credential-providers instead.

Keywords

FAQs

What is @aws-sdk/credential-provider-ini?

Is @aws-sdk/credential-provider-ini popular?

Is @aws-sdk/credential-provider-ini well maintained?

Last updated on 30 May 2024

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.

Install