Nicer Package Manager

    aws4-axios
    TypeScript icon, indicating that this package has built-in type declarations

    2.4.9 • Public • Published

    aws4-axios

    All Contributors

    npm version npm downloads

    This is a request interceptor for the Axios HTTP request library to allow requests to be signed with an AWSv4 signature.

    This may be useful for accessing AWS services protected with IAM auth such as an API Gateway.

    Installation

    yarn npm
    yarn add aws4-axios npm install --save aws4-axios

    Usage

    To add an interceptor to the default Axios client:

    import axios from "axios";
    import { aws4Interceptor } from "aws4-axios";
    
    const interceptor = aws4Interceptor({
      region: "eu-west-2",
      service: "execute-api",
    });
    
    axios.interceptors.request.use(interceptor);
    
    // Requests made using Axios will now be signed
    axios.get("https://example.com/foo").then((res) => {
      // ...
    });

    Or you can add the interceptor to a specific instance of an Axios client:

    import axios from "axios";
    import { aws4Interceptor } from "aws4-axios";
    
    const client = axios.create();
    
    const interceptor = aws4Interceptor({
      region: "eu-west-2",
      service: "execute-api",
    });
    
    client.interceptors.request.use(interceptor);
    
    // Requests made using Axios will now be signed
    client.get("https://example.com/foo").then((res) => {
      // ...
    });

    You can also pass AWS credentials in explicitly (otherwise taken from process.env)

    const interceptor = aws4Interceptor(
      {
        region: "eu-west-2",
        service: "execute-api",
      },
      {
        accessKeyId: "",
        secretAccessKey: "",
      }
    );

    You can also pass a custom CredentialsProvider factory instead

    const customCredentialsProvider = {
      getCredentials: async () => {
        return Promise.resolve({
          accessKeyId: "custom-provider-access-key-id",
          secretAccessKey: "custom-provider-secret-access-key"
        })
      }
    }
    
    const interceptor = aws4Interceptor(
      {
        region: "eu-west-2",
        service: "execute-api",
      },
      customCredentialsProvider
    );

    Assuming the IAM Role

    You can pass a parameter to assume the IAM Role with AWS STS and use the assumed role credentials to sign the request. This is useful when doing cross-account requests.

    const interceptor = aws4Interceptor(
      {
        region: "eu-west-2",
        service: "execute-api",
        assumeRoleArn: "arn:aws:iam::111111111111:role/MyRole",
      }
    );

    Obtained credentials are cached and refreshed as needed after they expire.

    You can use expirationMarginSec parameter to set the number of seconds before the received credentials expiration time to invalidate the cache. This allows setting a safety margin. Default to 5 seconds.

    Contributors

    Thanks goes to these wonderful people (emoji key):


    Florian Bischoff

    💻

    Ruben van Rooij

    💻

    Roman

    👀

    Maciej Radzikowski

    ⚠️ 💻

    Christopher Kruse

    ⚠️

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Install

    npm i aws4-axios

    DownloadsWeekly Downloads

    69,733

    Version

    2.4.9

    License

    MIT

    Unpacked Size

    98.7 kB

    Total Files

    41

    Last publish

    Collaborators

    • jbourne