Stone.js API
    Preparing search index...

    Interface S3DriverOptions

    Options for the S3 (and S3-compatible) driver.

    interface S3DriverOptions {
        baseUrl?: string;
        bucket: string;
        credentials?: {
            accessKeyId: string;
            secretAccessKey: string;
            sessionToken?: string;
        };
        endpoint?: string;
        forcePathStyle?: boolean;
        name?: string;
        region?: string;
        root?: string;
        signedUrlExpiresIn?: number;
    }

    Hierarchy

    • FileSystemOptions
      • S3DriverOptions
    Index
    baseUrl? bucket credentials? endpoint? forcePathStyle? name? region? root? signedUrlExpiresIn?
    baseUrl?: string

    An optional base URL used by FileSystem.url for public assets.

    bucket: string

    The bucket name.

    credentials?: {
        accessKeyId: string;
        secretAccessKey: string;
        sessionToken?: string;
    }

    Static credentials; omit to use the provider's default credential chain (env, role, etc.).

    endpoint?: string

    A custom endpoint for S3-compatible stores (R2, MinIO, OSS, COS).

    forcePathStyle?: boolean

    Use path-style addressing (endpoint/bucket/key), required by MinIO and some stores.

    name?: string

    The disk name.

    region?: string

    The region (required by AWS; optional for some S3-compatible stores).

    root?: string

    The root directory (local) or bucket/prefix (object store) all paths are resolved against.

    signedUrlExpiresIn?: number

    Default expiry (seconds) for signed URLs. Defaults to 900 (15 min).

    Settings
    Member Visibility

    On This Page
    Properties