S3ProviderOptions
Defined in: src/providers/web/S3Provider.ts:60
Options accepted by createS3ProviderFactory.
Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
bucket? | string | Required bucket name; can be overridden per connection via profile.host. | src/providers/web/S3Provider.ts:64 |
defaultHeaders? | Record<string, string> | Default headers applied to every request before signing. | src/providers/web/S3Provider.ts:76 |
endpoint? | string | Custom endpoint base URL (e.g. MinIO, R2). Defaults to https://s3.<region>.amazonaws.com. | src/providers/web/S3Provider.ts:70 |
fetch? | HttpFetch | Custom fetch implementation. Defaults to global fetch. | src/providers/web/S3Provider.ts:74 |
id? | ProviderId | Provider id to register. Defaults to "s3". | src/providers/web/S3Provider.ts:62 |
multipart? | S3MultipartOptions | Multipart upload tuning. Enabled by default; see S3MultipartOptions.enabled. | src/providers/web/S3Provider.ts:80 |
pathStyle? | boolean | Whether to use path-style URLs (endpoint/bucket/key). Defaults to true. | src/providers/web/S3Provider.ts:72 |
region? | string | AWS region. Defaults to "us-east-1". | src/providers/web/S3Provider.ts:66 |
service? | string | Service identifier for SigV4. Defaults to "s3". | src/providers/web/S3Provider.ts:68 |
sessionToken? | SecretSource | Optional STS session token applied to every request. | src/providers/web/S3Provider.ts:78 |