@aws-sdk/credential-provider-env
Advanced tools
AWS credential provider that sources credentials from known environment variables
The @aws-sdk/credential-provider-env package is designed to provide AWS credentials from environment variables to applications. It is part of the AWS SDK for JavaScript (v3), which is a modular collection of software for interfacing with AWS services. This package specifically helps in retrieving AWS credentials set in the environment variables, making it easier to manage credentials in a secure and scalable way, especially in containerized or serverless environments where direct file access might be limited.
Retrieving AWS credentials from environment variables
This feature allows the application to automatically load AWS credentials (such as AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and optionally AWS_SESSION_TOKEN) from the environment variables. It is particularly useful in automated environments like CI/CD pipelines or when deploying to AWS services like AWS Lambda or ECS, where you can set environment variables securely.
const { fromEnv } = require('@aws-sdk/credential-provider-env');
const credentials = fromEnv();
// Use the credentials with an AWS SDK clientThe 'aws-sdk' package is the older version of the AWS SDK for JavaScript. It also supports loading credentials from environment variables, but it does so as part of a larger, monolithic package. Compared to @aws-sdk/credential-provider-env, 'aws-sdk' is less modular and might introduce more dependencies than necessary if you only need to load credentials.
Similar to @aws-sdk/credential-provider-env, this package is part of the AWS SDK for JavaScript (v3) and provides functionality to load AWS credentials. However, instead of loading from environment variables, it loads credentials from a shared credentials file (typically located at ~/.aws/credentials). This approach is useful for local development or in scenarios where setting environment variables is not preferred.
This package is another credential provider within the AWS SDK for JavaScript (v3) ecosystem. It differs from @aws-sdk/credential-provider-env by providing a way to obtain AWS credentials based on Cognito Identity. This is particularly useful for mobile or web applications that authenticate users and then provide access to AWS resources directly from the client-side.
This module provides a CredentialProvider function, fromEnv, that reads from
the following environment variables:
AWS_ACCESS_KEY_ID - The access key for your AWS account.AWS_SECRET_ACCESS_KEY - The secret key for your AWS account.AWS_SESSION_TOKEN - The session key for your AWS account. This is only
needed when you are using temporary credentials.AWS_CREDENTIAL_EXPIRATION - The expiration time of the credentials contained
in the environment variables described above. This value must be in a format
compatible with the ISO-8601 standard
and is only needed when you are using temporary credentials.If either the AWS_ACCESS_KEY_ID or AWS_SECRET_ACCESS_KEY environment
variable is not set or contains a falsy value, the promise returned by the
fromEnv function will be rejected.
FAQs
AWS credential provider that sources credentials from known environment variables
The npm package @aws-sdk/credential-provider-env receives a total of 16,146,457 weekly downloads. As such, @aws-sdk/credential-provider-env popularity was classified as popular.
We found that @aws-sdk/credential-provider-env 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
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.