/node-aws4-with-assume-role

aws4 with assume role

Primary LanguageJavaScript

aws4-with-assume-role

aws4 with assume role.

Installation

npm i aws4-with-assume-role

Usage

const { makeSigner } = require('aws4-with-assume-role');

makeSigner({
  profile: 'my_profile',
  region: 'us-west-2',
}, (err, sign) => {
  if (err) {
    return callback(err);
  }

  /*
   * Make a signed request options with credentials of 'my_profile'.
   */
  const requestOptions = sign({
    service: 's3',
    path: '/',
    signQuery: true,
  });
});

makeSigner([options, ]callback)

  • options.profile
    • A name of a profile that gets a credential.
  • options.region
    • A target region to which an request calls.
  • callback(err, sign)
    • A function that is called when a signer function has made or an error occurs.

License

MIT