Libraries v5.0.0
    Preparing search index...

    Interface S3StorageOptions

    One adapter targets one bucket. Create separate instances for other providers.

    interface S3StorageOptions {
        bucket: string;
        credentials: S3Credentials;
        endpoint: string;
        forcePathStyle?: boolean;
        keyPrefix?: string;
        partSize?: number;
        publicBaseUrl?: string;
        queueSize?: number;
        region: string;
        requestChecksumCalculation?: "WHEN_REQUIRED" | "WHEN_SUPPORTED";
        requestTimeoutMs?: number;
        responseChecksumValidation?: "WHEN_REQUIRED" | "WHEN_SUPPORTED";
    }
    Index
    bucket credentials endpoint forcePathStyle? keyPrefix? partSize? publicBaseUrl? queueSize? region requestChecksumCalculation? requestTimeoutMs? responseChecksumValidation?
    bucket: string
    credentials: S3Credentials
    endpoint: string
    forcePathStyle?: boolean

    Defaults to true for self-hosted endpoints.

    keyPrefix?: string
    partSize?: number

    Multipart buffer size, at least 5 MiB. Defaults to 5 MiB.

    publicBaseUrl?: string

    Public bucket/proxy root; the encoded key prefix is appended automatically.

    queueSize?: number

    Number of concurrently buffered parts. Defaults to four.

    region: string
    requestChecksumCalculation?: "WHEN_REQUIRED" | "WHEN_SUPPORTED"
    requestTimeoutMs?: number

    Per-request network timeout, including cleanup requests. Defaults to 30 seconds.

    responseChecksumValidation?: "WHEN_REQUIRED" | "WHEN_SUPPORTED"

    Settings
    Member Visibility

    On This Page
    Properties