Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SignatureV4Init

Hierarchy

Index

Properties

Optional applyChecksum

applyChecksum: boolean

Whether to calculate a checksum of the request body and include it as either a request header (when signing) or as a query string parameter (when presigning). This is required for AWS Glacier and Amazon S3 and optional for every other AWS service as of late 2017.

default

[true]

credentials

The credentials with which the request should be signed or a function that returns a promise that will be resolved with credentials.

region

region: string | Provider<string>

The region name or a function that returns a promise that will be resolved with the region name.

service

service: string

The service signing name.

Optional sha256

A constructor function for a hash object that will calculate SHA-256 HMAC checksums.

Optional uriEscapePath

uriEscapePath: boolean

Whether to uri-escape the request URI path as part of computing the canonical request string. This is required for every AWS service, except Amazon S3, as of late 2017.

default

[true]