@aws-sdk/credential-provider-process
Advanced tools
AWS credential provider that sources credential_process from ~/.aws/credentials and ~/.aws/config
Package description
The @aws-sdk/credential-provider-process package is part of the AWS SDK for JavaScript (v3) and is used to load AWS credentials from a process specified in the shared AWS config and credentials files. This is useful for scenarios where you want to source credentials from an external process, which can be a custom credential provider or a token service.
Loading credentials from a process
This feature allows you to load AWS credentials by executing a process defined in your AWS config file. The credentials returned by the process are then used to authenticate AWS SDK clients.
const { fromProcess } = require('@aws-sdk/credential-provider-process');
const credentials = fromProcess();
// Use credentials with an AWS SDK client
const client = new SomeAwsClient({ credentials });This package is similar to @aws-sdk/credential-provider-process in that it is also used to load AWS credentials, but it does so from the AWS shared configuration file (typically located at ~/.aws/credentials). It does not execute an external process to obtain credentials.
This package provides a way to retrieve AWS credentials by using Amazon Cognito Identity. It is different from @aws-sdk/credential-provider-process as it specifically targets Cognito for authentication rather than executing a custom process.
This package is designed to retrieve AWS credentials from web identity token files, which is useful for workloads running on EKS or using OIDC identity providers. Unlike @aws-sdk/credential-provider-process, it does not involve running a separate process to obtain credentials.
This package allows users to retrieve AWS credentials using AWS Single Sign-On (SSO). It differs from @aws-sdk/credential-provider-process by focusing on SSO as the credential source rather than a custom process.
Readme
This module provides a function, fromSharedConfigFiles that will create
CredentialProvider functions that read from a shared credentials file at
~/.aws/credentials and a shared configuration file at ~/.aws/config. Both
files are expected to be INI formatted with section names corresponding to
profiles. Sections in the credentials file are treated as profile names, whereas
profile sections in the config file must have the format of[profile profile-name], except for the default profile. Please see the sample
files below for examples of well-formed configuration and
credentials files.
Profiles that appear in both files will not be merged, and the version that appears in the credentials file will be given precedence over the profile found in the config file.
You may customize how credentials are resolved by providing an options hash to
the fromSharedConfigFiles factory function. The following options are
supported:
profile - The configuration profile to use. If not specified, the provider
will use the value in the AWS_PROFILE environment variable or a default of
default.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.~/.aws/credentials[default]
credential_process = /usr/local/bin/awscreds
[dev]
credential_process = /usr/local/bin/awscreds dev
[prod]
credential_process = /usr/local/bin/awscreds prod
~/.aws/config[default]
credential_process = /usr/local/bin/awscreds
[profile dev]
credential_process = /usr/local/bin/awscreds dev
[profile prod]
credential_process = /usr/local/bin/awscreds prod
FAQs
AWS credential provider that sources credential_process from ~/.aws/credentials and ~/.aws/config
The npm package @aws-sdk/credential-provider-process receives a total of 15,126,289 weekly downloads. As such, @aws-sdk/credential-provider-process popularity was classified as popular.
We found that @aws-sdk/credential-provider-process demonstrated a healthy version release cadence and project activity because the last version was released less than 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
uv, Python's new package manager, offers a faster and more efficient alternative to pip with features that simplify tooling, manage Python versions, and streamline development workflows.
Research
Security News
Socket researchers have uncovered 3.7 million fake GitHub stars, highlighting a growing threat linked to scams, fraud, and malware, with these campaigns rapidly increasing over the last six months.
Security News
Deno's Standard Library has stabilized after four years of development, offering developers a collection of well-maintained tools compatible with Deno, Node.js, Cloudflare Workers, and browsers with bundlers.