fgb-vt - v1.0.4
    Preparing search index...

    Interface S3ConnectorOptions

    Configuration options for S3Connector.

    interface S3ConnectorOptions {
        credentials?: {
            accessKeyId: string;
            secretAccessKey: string;
            sessionToken?: string;
        };
        endpoint?: string;
        forcePathStyle?: boolean;
        maxConcurrency?: number;
        region: string;
    }
    Index

    Properties

    credentials? endpoint? forcePathStyle? maxConcurrency? region

    Properties

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

    Explicit AWS credentials.

    When omitted, the SDK falls back to the default credential provider chain (environment variables, shared credentials file, EC2 instance metadata, ECS container credentials, etc.).

    Type Declaration

    • accessKeyId: string

      AWS access key ID.

    • secretAccessKey: string

      AWS secret access key.

    • OptionalsessionToken?: string

      Optional session token for temporary credentials (STS).

    endpoint?: string

    Custom endpoint URL for S3-compatible object stores.

    Set this when targeting MinIO, Cloudflare R2, Backblaze B2, or any other store that exposes an S3-compatible API at a non-AWS endpoint.

    forcePathStyle?: boolean

    Force path-style addressing (endpoint/bucket/key) instead of the default virtual-hosted style (bucket.endpoint/key).

    Required by some S3-compatible stores that do not support virtual-hosted bucket addressing.

    maxConcurrency?: number

    Maximum number of concurrent GetObject calls within a single S3Connector.readRanges invocation.

    10
    region: string

    AWS region for the S3 client (e.g. "us-east-1").

    Settings

    Member Visibility

    On This Page

    Properties