Class SigV4Signer

A Signer that signs requests using the AWS Signature Version 4 (SigV4) signing process.

The signer takes and returns web-standard Request objects and performs no network I/O. To send signed requests, pass an instance to createSignedFetcher from @aws-lambda-powertools/signer/fetch.

Example

import { SigV4Signer } from '@aws-lambda-powertools/signer/sigv4';

const signer = new SigV4Signer({ service: 'execute-api' });
const signed = await signer.sign('https://example.execute-api.us-east-1.amazonaws.com/items');

Implements

Signer

Index

Constructors

constructor

Methods

sign

Constructors

constructor

new SigV4Signer(options: SigV4SignerOptions): SigV4Signer
Parameters
- options: SigV4SignerOptions
Returns SigV4Signer
- Defined in packages/signer/src/SigV4Signer.ts:56

Methods

sign

sign(input: string | URL | Request, init?: RequestInit): Promise<Request>
Sign a request and return a new, signed Request.
Parameters
- input: string | URL | Request
  The resource to sign, as a URL string, URL, or Request.
- Optionalinit: RequestInit
  Optional request options, matching the fetch init argument.
Returns Promise<Request>
Implementation of Signer.sign
- Defined in packages/signer/src/SigV4Signer.ts:70

Class SigV4Signer

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SigV4Signer

Methods

sign

Parameters

Returns Promise<Request>

Settings

On This Page