Interface S3ClientConfig

Configuration object compatible with @aws-sdk/client-s3's S3Client constructor.

interface S3ClientConfig {
    credentials: { accessKeyId: string; secretAccessKey: string };
    endpoint: string;
    forcePathStyle: boolean;
    region: string;
}

Index

Properties

credentials endpoint forcePathStyle region

Properties

`Readonly`credentials

credentials: { accessKeyId: string; secretAccessKey: string }

AWS-style credentials — the B2 application key pair.

Type Declaration

ReadonlyaccessKeyId: string
The B2 application key ID, used as the S3 access key ID.
ReadonlysecretAccessKey: string
The B2 application key (secret), used as the S3 secret access key.

`Readonly`endpoint

endpoint: string

The S3-compatible endpoint URL (e.g., https://s3.us-west-004.backblazeb2.com).

`Readonly`forcePathStyle

forcePathStyle: boolean

Always true for B2, which requires path-style bucket addressing.

`Readonly`region

region: string

The S3 region identifier (e.g., us-west-004).

Interface S3ClientConfig

Index

Properties

Properties

`Readonly`credentials

Type Declaration

`Readonly`accessKeyId: string

`Readonly`secretAccessKey: string

`Readonly`endpoint

`Readonly`forcePathStyle

`Readonly`region

Settings

On This Page

Interface S3ClientConfig

Index

Properties

Properties

Readonlycredentials

Type Declaration

ReadonlyaccessKeyId: string

ReadonlysecretAccessKey: string

Readonlyendpoint

ReadonlyforcePathStyle

Readonlyregion

Settings

On This Page

`Readonly`credentials

`Readonly`accessKeyId: string

`Readonly`secretAccessKey: string

`Readonly`endpoint

`Readonly`forcePathStyle

`Readonly`region