---
id: "aws-efs"
type: "component"
kind: "file-storage"
provider: "aws"
category: "data"
aliases: "EFS"
docs: "https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html"
url: "https://localhost:3000/catalogue/components/aws-efs"
---

# Amazon EFS

Serverless elastic NFS file system spanning multiple Availability Zones with elastic throughput.

| | |
|---|---|
| Provider | [aws](https://localhost:3000/catalogue?provider=aws) |
| Kind | [File share](https://localhost:3000/catalogue/kinds/file-storage) |
| Category | Data |
| Official docs | [https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html](https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html) |

## Properties

| property | type | values | required | kind default | this component |
|---|---|---|---|---|---|
| `backupEnabled` | boolean | — | no | false | **true** |
| `backupRetentionDays` | integer | — | no | 35 | inherited |
| `encryptionAtRest` | boolean | — | no | true | inherited |
| `encryptionInTransit` | boolean | — | no | — | **false** |
| `fileSystemType` | enum | `regional`, `one-zone` | no | "regional" | inherited |
| `managed` | boolean | — | no | false | **true** |
| `performanceMode` | enum | `general-purpose`, `max-io` | no | "general-purpose" | inherited |
| `protocol` | enum | `nfs`, `smb`, `multi`, `lustre`, `native` | yes | — | **"nfs"** |
| `publicAccess` | boolean | — | no | — | **false** |
| `quotaGib` | integer | — | no | — | inherited |
| `redundancy` | enum | `local`, `zonal`, `regional` | no | — | **"regional"** |
| `throughputMode` | enum | `elastic`, `bursting`, `provisioned` | no | "elastic" | inherited |

Bold values are the ones this component pins.

## Rules that apply · 0

No rule selects this kind or its category.

## Other products of the same kind · 35

- [Apsara File Storage for HDFS](https://localhost:3000/catalogue/components/alibaba-file-storage-hdfs.md) `alibaba-file-storage-hdfs` — alibabacloud
- [Apsara File Storage NAS](https://localhost:3000/catalogue/components/alibaba-nas.md) `alibaba-nas` — alibabacloud
- [Amazon File Cache](https://localhost:3000/catalogue/components/aws-file-cache.md) `aws-file-cache` — aws
- [Amazon FSx for Lustre](https://localhost:3000/catalogue/components/aws-fsx-lustre.md) `aws-fsx-lustre` — aws
- [Amazon FSx for NetApp ONTAP](https://localhost:3000/catalogue/components/aws-fsx-ontap.md) `aws-fsx-ontap` — aws
- [Amazon FSx for OpenZFS](https://localhost:3000/catalogue/components/aws-fsx-openzfs.md) `aws-fsx-openzfs` — aws
- [Amazon FSx for Windows File Server](https://localhost:3000/catalogue/components/aws-fsx-windows.md) `aws-fsx-windows` — aws
- [Azure File Sync](https://localhost:3000/catalogue/components/azure-file-sync.md) `azure-file-sync` — azure
- [Azure Files](https://localhost:3000/catalogue/components/azure-files.md) `azure-files` — azure
- [Azure Managed Lustre](https://localhost:3000/catalogue/components/azure-managed-lustre.md) `azure-managed-lustre` — azure
- [Azure NetApp Files](https://localhost:3000/catalogue/components/azure-netapp-files.md) `azure-netapp-files` — azure
- [BeeGFS](https://localhost:3000/catalogue/components/beegfs.md) `beegfs` — default
- [CephFS](https://localhost:3000/catalogue/components/cephfs.md) `cephfs` — default
- [CubeFS](https://localhost:3000/catalogue/components/cubefs.md) `cubefs` — default
- [Curvine](https://localhost:3000/catalogue/components/curvine.md) `curvine` — default
- [Generic file share](https://localhost:3000/catalogue/components/file-storage.md) `file-storage` — default
- [File store](https://localhost:3000/catalogue/components/file-store.md) `file-store` — default
- [GlusterFS](https://localhost:3000/catalogue/components/glusterfs.md) `glusterfs` — default
- [HDFS](https://localhost:3000/catalogue/components/hdfs.md) `hdfs` — default
- [JuiceFS](https://localhost:3000/catalogue/components/juicefs.md) `juicefs` — default
- [Lustre](https://localhost:3000/catalogue/components/lustre.md) `lustre` — default
- [MooseFS](https://localhost:3000/catalogue/components/moosefs.md) `moosefs` — default
- [Nextcloud](https://localhost:3000/catalogue/components/nextcloud.md) `nextcloud` — default
- [NFS server](https://localhost:3000/catalogue/components/nfs-server.md) `nfs-server` — default
- [Samba](https://localhost:3000/catalogue/components/samba.md) `samba` — default
- [DigitalOcean Network File Storage](https://localhost:3000/catalogue/components/digitalocean-nfs.md) `digitalocean-nfs` — digitalocean
- [Filestore](https://localhost:3000/catalogue/components/google-filestore.md) `google-filestore` — gcp
- [Google Cloud Managed Lustre](https://localhost:3000/catalogue/components/google-managed-lustre.md) `google-managed-lustre` — gcp
- [Google Cloud NetApp Volumes](https://localhost:3000/catalogue/components/google-netapp-volumes.md) `google-netapp-volumes` — gcp
- [Parallelstore](https://localhost:3000/catalogue/components/google-parallelstore.md) `google-parallelstore` — gcp
- [File Storage for VPC](https://localhost:3000/catalogue/components/ibm-file-storage.md) `ibm-file-storage` — ibm
- [File Storage for Classic](https://localhost:3000/catalogue/components/ibm-file-storage-classic.md) `ibm-file-storage-classic` — ibm
- [OCI File Storage](https://localhost:3000/catalogue/components/oci-file-storage.md) `oci-file-storage` — oci
- [OCI File Storage with Lustre](https://localhost:3000/catalogue/components/oci-file-storage-lustre.md) `oci-file-storage-lustre` — oci
- [OpenStack Manila](https://localhost:3000/catalogue/components/openstack-manila.md) `openstack-manila` — openstack

## Use it in a design

```yaml
nodes:
  - { id: "aws-efs", component: "aws-efs" }
```

## Source (`component` YAML, verbatim)

```yaml
# yaml-language-server: $schema=../../schema/component.schema.json
# Amazon EFS file system: serverless elastic NFSv4.1 file storage. "What is Amazon Elastic File System?"
# gives Regional (multi-AZ) as the recommended default type with General Purpose performance and Elastic
# throughput; "Encrypting data at rest": encryption at rest is enabled by default in the console (CLI/API
# must enable it); "Backing up EFS file systems": console-created file systems get daily AWS Backup with
# 35-day retention.
schemaVersion: "1"
type: "component"
id: "aws-efs"
kind: "file-storage"
provider: "aws"
docs: "https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html"
aliases: ["EFS"]
defaults:
  protocol: "nfs"
  redundancy: "regional"
  encryptionInTransit: false
  publicAccess: false
  backupEnabled: true
  managed: true
properties:
  fileSystemType:
    type: "enum"
    values: ["regional", "one-zone"]
    default: "regional"
  performanceMode:
    type: "enum"
    values: ["general-purpose", "max-io"]
    default: "general-purpose"
  throughputMode:
    type: "enum"
    values: ["elastic", "bursting", "provisioned"]
    default: "elastic"
  encryptionAtRest:
    type: "boolean"
    default: true
  backupRetentionDays:
    type: "integer"
    default: 35
```

Human page: https://localhost:3000/catalogue/components/aws-efs