Skip to content

Interface: HttpAwsSignatureAuth ​

AWS Signature Version 4 over the final request: its method, URL, headers and body. In the authorization and x-amz-* headers or, with addTo: 'QUERY_PARAMS', in the X-Amz-* query parameters of a presigned URL.

Properties ​

accessKey ​

ts
accessKey: string;

ctx.secret(name).


addTo? ​

ts
optional addTo?: HttpAuthAddTo;

authType ​

ts
authType: "aws-signature";

region ​

ts
region: string;

The region the request is signed for, such as eu-west-1.


secretKey ​

ts
secretKey: string;

ctx.secret(name).


serviceName ​

ts
serviceName: string;

The service's signing name, such as execute-api or s3.


serviceToken? ​

ts
optional serviceToken?: string;

The session token of temporary credentials: ctx.secret(name).

Released under the Apache-2.0 License.