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

    Interface S3ConnectorOptions

    Configuration options for S3Connector.

    interface S3ConnectorOptions {
        cacheNamespace?: string;
        client?: S3ClientLike;
        coalesceGap?: number;
        credentials?: {
            accessKeyId: string;
            secretAccessKey: string;
            sessionToken?: string;
        };
        endpoint?: string;
        expectedBucketOwner?: string;
        forcePathStyle?: boolean;
        getObjectParams?: Record<string, unknown>;
        maxConcurrency?: number;
        prefetch?: number;
        region?: string;
        requestPayer?: "requester";
        sdk?: S3SdkModule;
        timeout?: number;
    }
    Index
    cacheNamespace? client? coalesceGap? credentials? endpoint? expectedBucketOwner? forcePathStyle? getObjectParams? maxConcurrency? prefetch? region? requestPayer? sdk? timeout?
    cacheNamespace?: string

    Cache namespace (see Connector.cacheNamespace). Defaults to s3:<endpoint> (s3:aws without an endpoint); with an injected client whose endpoint is unknown, cache entries are private to this connector unless a namespace is given.

    client?: S3ClientLike

    An existing S3Client to send requests with, e.g. one shared with the rest of the application. The connector does not destroy it on S3Connector.close. region, credentials, endpoint and forcePathStyle are ignored.

    coalesceGap?: number

    Merge byte ranges separated by at most this many bytes into one request.

    65536 (64 KiB)
    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.

    expectedBucketOwner?: string

    Account id the bucket must belong to; requests to a bucket owned by another account fail with 403 (ExpectedBucketOwner).

    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.

    getObjectParams?: Record<string, unknown>

    Further GetObject input sent with every request, e.g. server-side encryption with customer keys: { SSECustomerAlgorithm: 'AES256', SSECustomerKey, SSECustomerKeyMD5 }. Bucket, Key, Range, IfMatch and VersionId are set by the connector.

    maxConcurrency?: number

    Most GetObject requests in flight at once across all reads through this connector (every tile and source sharing it); further requests wait in arrival order. Matches the SDK's default socket pool (50) so that requests queue here, where they can be cancelled, rather than in the HTTP agent. Infinity disables the limit.

    50
    prefetch?: number

    Size of the first read of a file (header plus top of the index).

    262144 (256 KiB)
    region?: string

    AWS region for the S3 client (e.g. "us-east-1"). When omitted, the SDK takes it from the environment (AWS_REGION). Ignored with client.

    requestPayer?: "requester"

    Set to 'requester' to read from Requester Pays buckets (the requester is charged for the requests and transfer).

    sdk?: S3SdkModule

    The @aws-sdk/client-s3 module, e.g. import * as s3 from '@aws-sdk/client-s3'. Pass it when bundling the SDK into your application; otherwise it is imported at runtime on first use.

    timeout?: number

    Timeout per GetObject in milliseconds, covering the response and its body, so a stalled connection cannot hold a request slot forever. The SDK's own retries (maxAttempts) happen within it. 0 or Infinity disable the timeout.

    30000

    Settings
    Member Visibility

    On This Page
    Properties