AWS Fundamentals Logo
AWS Fundamentals
AWS::EFS::FileSystem

EFS FileSystem

The AWS::EFS::FileSystem resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource.

Properties

13 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
AvailabilityZoneName
string
Create-only
BackupPolicy
BackupPolicy
BypassPolicyLockoutSafetyCheck
boolean
Write-only
Encrypted
boolean
Create-only
FileSystemPolicy
object
FileSystemProtection
FileSystemProtection
FileSystemTags
Array<ElasticFileSystemTag>
KmsKeyId
string
Create-only
LifecyclePolicies
Array<LifecyclePolicy>
PerformanceMode
string
Create-only
ProvisionedThroughputInMibps
number
ReplicationConfiguration
ReplicationConfiguration
ThroughputMode
string

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
Arnstring-
FileSystemIdstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::EFS::FileSystem

Resources:
  MyResource:
    Type: AWS::EFS::FileSystem
    Properties:

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

elasticfilesystem:CreateFileSystemelasticfilesystem:DescribeReplicationConfigurationselasticfilesystem:TagResourceelasticfilesystem:CreateReplicationConfigurationelasticfilesystem:DescribeFileSystemselasticfilesystem:PutBackupPolicyelasticfilesystem:PutFileSystemPolicyelasticfilesystem:PutLifecycleConfiguration

read

elasticfilesystem:DescribeBackupPolicyelasticfilesystem:DescribeFileSystemPolicyelasticfilesystem:DescribeFileSystemselasticfilesystem:DescribeLifecycleConfigurationelasticfilesystem:DescribeReplicationConfigurations

update

elasticfilesystem:CreateReplicationConfigurationelasticfilesystem:DeleteFileSystemPolicyelasticfilesystem:DescribeBackupPolicyelasticfilesystem:DescribeFileSystemPolicyelasticfilesystem:DescribeFileSystemselasticfilesystem:DescribeLifecycleConfigurationelasticfilesystem:DescribeReplicationConfigurationselasticfilesystem:DeleteTags

delete

elasticfilesystem:DescribeFileSystemselasticfilesystem:DeleteFileSystemelasticfilesystem:DeleteReplicationConfigurationelasticfilesystem:DescribeReplicationConfigurations

list

elasticfilesystem:DescribeBackupPolicyelasticfilesystem:DescribeFileSystemPolicyelasticfilesystem:DescribeFileSystemselasticfilesystem:DescribeLifecycleConfigurationelasticfilesystem:DescribeReplicationConfigurations

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceEFS
Properties15
Required0
TaggingSupported
Primary IDFileSystemId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

AvailabilityZoneNameEncryptedKmsKeyIdPerformanceMode

Related Resources

External Links