The HTTP request to sign.
Configuration for signing.
A Future whose result will be the signed HttpRequest. The future will contain an exception if the signing process fails.
Returns the AWS CRT version
Enables logging of the native AWS CRT libraries.
The logging level to filter to. It is not possible to log less than WARN.
nodejs only.
Computes an MD5 hash. Use this if you don't need to stream the data you're hashing and can load the entire input into memory.
The data to hash
The maximum number of bytes to receive. Leave as undefined or 0 to receive the entire digest.
Computes an SHA256 hash. Use this if you don't need to stream the data you're hashing and can load the entire input into memory.
The data to hash
The maximum number of bytes to receive. Leave as undefined or 0 to receive the entire digest.
Computes an SHA256 HMAC. Use this if you don't need to stream the data you're hashing and can load the entire input into memory.
The key to use for the HMAC process
The data to hash
The maximum number of bytes to receive. Leave as undefined or 0 to receive the entire digest.
Returns true if ALPN is available on this platform natively
true if ALPN is supported natively, false otherwise
nodejs only.
Returns true if this script is running in a browser
Returns true if this script is running under nodejs
If the AWS_CRT_MEMORY_TRACING
is environment variable is set to 1 or 2,
will return the native memory usage in bytes. Otherwise, returns 0.
The total allocated native memory, in bytes.
Dumps outstanding native memory allocations. If the AWS_CRT_MEMORY_TRACING
environment variable is set to 1 or 2, will dump all active native memory to
the console log.
Returns the package information for aws-crt-nodejs
Use this function to create a resource in an async context. This will make sure the resources are cleaned up before returning.
Example:
await using(res = new SomeResource(), async (res) => {
res.do_the_thing();
});
Configuration for use in AWS-related signing. AwsSigningConfig is immutable. It is good practice to use a new config for each signature, or the date might get too old.
The types that are acceptable to use as input for hashing.
Headers are exposed as 2 element arrays: [name, value]
Possible types of data to send via publish or receive via subscription
Generated using TypeDoc
Perform AWS HTTP request signing.
The HttpRequest is transformed asynchronously, according to the AwsSigningConfig.
When signing:
It is good practice to use a new config for each signature, or the date might get too old.
Do not add the following headers to requests before signing, they may be added by the signer: x-amz-content-sha256, X-Amz-Date, Authorization
Do not add the following query params to requests before signing, they may be added by the signer: X-Amz-Signature, X-Amz-Date, X-Amz-Credential, X-Amz-Algorithm, X-Amz-SignedHeaders