awslabs/mountpoint-s3
Mountpoint S3
Mountpoint for Amazon S3 is a FUSE-based filesystem client that mounts S3 buckets as local directories, enabling standard file operations on objects without custom code. It enforces S3 bucket permissions through AWS Identity and Access Management policies on every operation, and implements lazy object materialization to fetch content on-demand rather than downloading entire objects at mount time. The filesystem maps S3's flat key namespace into a hierarchical directory structure using forward slashes as path separators, and supports write-back object assembly that accumulates local writes into a temporary buffer before uploading the complete object on file close.
The client distinguishes itself through parallel part-level throughput for read and write performance, a metadata caching layer that reduces S3 List and HeadObject calls with configurable time-to-live, and support for mounting via access point ARNs, bucket prefixes, Multi-Region Access Points, and Object Lambda Access Points. It provides mount-time controls for file permissions, ownership, and multi-user access, along with flags to restrict or allow file creation, deletion, overwriting, renaming, and appending. Storage class configuration for new objects, server-side encryption settings, and custom endpoint routing for IPv6, Transfer Acceleration, or PrivateLink are also available.
Additional capabilities include automatic boot-time mounting through fstab, FUSE file descriptor mounting for containerized environments, and network throughput and concurrency tuning for high-throughput workloads. The client exports internal FUSE and S3 request metrics via OpenTelemetry for monitoring, and supports local and shared object content caching to reduce redundant reads from the mounted bucket.
Features
- S3 Object Mounting - Mounts Amazon S3 buckets as local filesystem directories for standard file operations.
- S3 FUSE Clients - The core product: a FUSE-based client that mounts S3 buckets as local directories for standard file operations.
- Parallel Part-Level Throughput - Improves read and write performance by splitting large objects into parts and issuing concurrent S3 requests for each part.
- Mount Permission Controls - Restricts read, write, and delete permissions on mounted S3 objects via IAM and mount flags.
- S3 Write-Back Object Assembly - Accumulates local writes into a buffer and uploads the complete object to S3 on file close.
- FUSE Virtual Filesystems - Implements a FUSE-based filesystem that exposes S3 objects as a local directory.
- IAM Policy Restrictions - Enforces S3 bucket permissions through IAM policies on every object operation at the filesystem level.
- S3 IAM Policy Enforcement - Enforces AWS IAM policies on every S3 object operation for access control.
- S3 Object On-Demand Fetching - Fetches S3 object content on-demand during reads instead of downloading entire objects.
- S3 Key-to-Directory Mappings - Maps flat S3 key namespaces into hierarchical directory structures using forward slashes.
- S3 Throughput Optimizers - Provides tunable network throughput, concurrency, and part-size parameters for high-volume S3 data transfers.
- Object Storage Caches - Stores object content on local instance storage or EBS to avoid redundant reads from the mounted bucket.
- S3 Object Content Caches - Ships local and shared object content caching to avoid redundant reads from mounted S3 buckets.
- Filesystem Metadata Caches - Caches file metadata locally with configurable TTL to reduce repeated S3 List and HeadObject calls.
- New Object Storage Class Settings - Specifies the S3 storage class for newly created objects in the mounted bucket.
- Access Point Mounting - Mounts S3 buckets using access point ARNs for distinct permissions and network controls.
- Multi-Region - Mount an S3 bucket using a Multi-Region Access Point ARN for a global endpoint across multiple AWS regions.
- Prefix-Based Subdirectory Mounting - Mounts only a subdirectory of an S3 bucket under a specified prefix for access isolation.
- Mount Flag File Operation Controls - Controls file creation, deletion, overwriting, renaming, and appending through mount flags.
- Mount Point Permission Settings - Sets local file mode, ownership, and cross-user access for the mounted S3 directory.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
