Configuration Options¶
Environment Variables¶
A complete list of environment variables which can be set to configure the client.
| Key | Default | Description |
|---|---|---|
| s3fs.access.key | none | AWS access key, used to identify the user interacting with AWS |
| s3fs.secret.key | none | AWS secret access key, used to authenticate the user interacting with AWS |
| s3fs.request.metric.collector.class | TODO | Fully-qualified class name to instantiate an AWS SDK request/response metric collector |
| s3fs.cache.attributes.ttl | 60000 | TTL for the cached file attributes (in millis) |
| s3fs.cache.attributes.size | 5000 | Total size of cached file attributes |
| s3fs.connection.timeout | TODO | Timeout (in milliseconds) for establishing a connection to a remote service |
| s3fs.max.connections | TODO | Maximum number of connections allowed in a connection pool |
| s3fs.max.retry.error | TODO | Maximum number of times that a single request should be retried, assuming it fails for a retryable error |
| s3fs.protocol | TODO | Protocol (HTTP or HTTPS) to use when connecting to AWS |
| s3fs.proxy.domain | none | For NTLM proxies: The Windows domain name to use when authenticating with the proxy |
| s3fs.proxy.protocol | none | Proxy connection protocol. |
| s3fs.proxy.host | none | Proxy host name either from the configured endpoint or from the "http.proxyHost" system property |
| s3fs.proxy.password | none | The password to use when connecting through a proxy |
| s3fs.proxy.port | none | Proxy port either from the configured endpoint or from the "http.proxyPort" system property |
| s3fs.proxy.username | none | The username to use when connecting through a proxy |
| s3fs.proxy.workstation | none | For NTLM proxies: The Windows workstation name to use when authenticating with the proxy |
| s3fs.region | none | The AWS Region to configure the client |
| s3fs.socket.send.buffer.size.hint | TODO | The size hint (in bytes) for the low level TCP send buffer |
| s3fs.socket.receive.buffer.size.hint | TODO | The size hint (in bytes) for the low level TCP receive buffer |
| s3fs.socket.timeout | TODO | Timeout (in milliseconds) for each read to the underlying socket |
| s3fs.user.agent.prefix | TODO | Prefix of the user agent that is sent with each request to AWS |
| s3fs.amazon.s3.factory.class | TODO | Fully-qualified class name to instantiate a S3 factory base class which creates a S3 client instance |
| s3fs.signer.override | TODO | Fully-qualified class name to define the signer that should be used when authenticating with AWS |
| s3fs.path.style.access | TODO | Boolean that indicates whether the client uses path-style access for all requests |
| s3fs.request.header.cache-control | blank | Configures the cacheControl on request builders (i.e. CopyObjectRequest, PutObjectRequest, etc) |