Skip to content

joaomilho/mappersmith-aws

Repository files navigation

mappersmith-aws

Mappersmith middeware for AWS Signature Version 4 signing process.

Usage

import forge from "mappersmith"
import { configAWSMiddleware } from "mappersmith-aws"

const AWSMiddleware = configAWSMiddleware({ 
  region: "us-east-1",
  service: "execute-api"
})

const api = forge({
  middleware: [
      ...,
      AWSMiddleware
  ]
  ...
})

Important: the middleware should always be the last one in your API definitions since it needs to be aware of all headers.

Params:

region mandatory string --
AWS region.
service mandatory string --
Name of the AWS service (s3, execute-api, etc...).
systemClockOffset optional number 0
Compensate for clock skew when your system may be out of sync with the AWS service time.
logger optional Console console
A logger to write debug details.
credentialsProvider optional (): Promise<AWS.Credentials> () => AWS.config.credentialProvider.resolvePromise()
An async function returning AWS credentials.