kinetex - v1.0.0-rc.1
    Preparing search index...

    Interface SigningConfig

    Configuration for AWS SigV4 signing.

    interface SigningConfig {
        credentials: AWSCredentials | CredentialProvider;
        region: string;
        service: string;
        signingDate?: string | Date;
        clockSkewSecs?: number;
        unsignedHeaders?: string[];
        unsignedPayload?: boolean;
        doubleEncodeUri?: boolean;
    }
    Index

    Properties

    credentials region service signingDate? clockSkewSecs? unsignedHeaders? unsignedPayload? doubleEncodeUri?

    Properties

    credentials: AWSCredentials | CredentialProvider

    AWS credentials or a provider that resolves them

    region: string

    AWS region, e.g. "us-east-1"

    service: string

    AWS service name, e.g. "s3", "execute-api", "sts"

    signingDate?: string | Date

    Override the signing date (ISO 8601 or Date). Defaults to current UTC time.

    clockSkewSecs?: number

    Clock skew correction in seconds. Applied when server returns a clock-skew error.

    unsignedHeaders?: string[]

    Headers to exclude from signing. These are appended to the default exclusion list.

    unsignedPayload?: boolean

    If true, the request body is not hashed (use for large S3 uploads). Sets x-amz-content-sha256: UNSIGNED-PAYLOAD

    doubleEncodeUri?: boolean

    If true, apply double URI encoding for path segments (default: true). S3 uses single encoding — set to false for S3.

    Settings

    Member Visibility

    On This Page

    Properties