Config

class Config

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
var algorithm: <Error class: unknown class>

The algorithm to sign with

Link copied to clipboard
var expiresAfter: <Error class: unknown class>?

If non-zero and the signing transform is query param, then signing will add X-Amz-Expires to the query string, equal to the value specified here. If this value is zero or if header signing is being used then this parameter has no effect.

Link copied to clipboard

Indicates whether the payload should be unsigned even in cases where it would otherwise be signable (e.g., a replayable stream or byte buffer). Setting this value to false will not allow signing a non-replayable stream.

Link copied to clipboard

Controls whether or not the uri paths should be normalized when building the canonical request

Link copied to clipboard

Flag indicating if the "X-Amz-Security-Token" query param should be omitted. Normally, this parameter is added during signing if the credentials have a session token. The only known case where this should be true is when signing a websocket handshake to IoT Core.

Link copied to clipboard

The credential scope service name to sign requests for NOTE: The operation context is favored when AwsSigningAttributes.SigningService is set

Link copied to clipboard
var shouldSignHeader: <Error class: unknown class>

A predicate to control which headers are a part of the canonical request. Note that skipping auth-required headers will result in an unusable signature. Headers injected by the signing process cannot be skipped.

Link copied to clipboard
var signatureType: <Error class: unknown class>

Sets what signature should be computed

Link copied to clipboard
var signedBodyHeader: <Error class: unknown class>

Controls what body "hash" header, if any, should be added to the canonical request and the signed request. Most services do not require this additional header.

Link copied to clipboard
var signer: <Error class: unknown class>?

The signer implementation to use for signing

Link copied to clipboard

The uri is assumed to be encoded once in preparation for transmission. Certain services do not decode before checking signature, requiring double-encoding the uri in the canonical request in order to pass a signature check.