See: Description
Interface | Description |
---|---|
AccessPointAttributes |
Attributes that can be specified when importing an AccessPoint.
|
AccessPointOptions |
Options to create an AccessPoint.
|
AccessPointProps |
Properties for the AccessPoint.
|
Acl |
Permissions as POSIX ACL.
|
CfnAccessPoint.AccessPointTagProperty |
A tag is a key-value pair attached to a file system.
|
CfnAccessPoint.CreationInfoProperty |
Required if the `RootDirectory` > `Path` specified does not exist.
|
CfnAccessPoint.PosixUserProperty |
The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.
|
CfnAccessPoint.RootDirectoryProperty |
Specifies the directory on the Amazon EFS file system that the access point provides access to.
|
CfnAccessPointProps |
Properties for defining a `CfnAccessPoint`.
|
CfnFileSystem.BackupPolicyProperty |
The backup policy turns automatic backups for the file system on or off.
|
CfnFileSystem.ElasticFileSystemTagProperty |
A tag is a key-value pair attached to a file system.
|
CfnFileSystem.LifecyclePolicyProperty |
Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that specifies when to transition files into and out of the file system's Infrequent Access (IA) storage class.
|
CfnFileSystemProps |
Properties for defining a `CfnFileSystem`.
|
CfnMountTargetProps |
Properties for defining a `CfnMountTarget`.
|
FileSystemAttributes |
Properties that describe an existing EFS file system.
|
FileSystemProps |
Properties of EFS FileSystem.
|
IAccessPoint |
Represents an EFS AccessPoint.
|
IAccessPoint.Jsii$Default |
Internal default implementation for
IAccessPoint . |
IFileSystem |
Represents an Amazon EFS file system.
|
IFileSystem.Jsii$Default |
Internal default implementation for
IFileSystem . |
PosixUser |
Represents the PosixUser.
|
Enum | Description |
---|---|
LifecyclePolicy |
EFS Lifecycle Policy, if a file is not accessed for given days, it will move to EFS Infrequent Access.
|
OutOfInfrequentAccessPolicy |
EFS Out Of Infrequent Access Policy, if a file is accessed given times, it will move back to primary storage class.
|
PerformanceMode |
EFS Performance mode.
|
ThroughputMode |
EFS Throughput mode.
|
---
Amazon Elastic File System (Amazon EFS) provides a simple, scalable, fully managed elastic NFS file system for use with AWS Cloud services and on-premises resources. Amazon EFS provides file storage in the AWS Cloud. With Amazon EFS, you can create a file system, mount the file system on an Amazon EC2 instance, and then read and write data to and from your file system.
This module is part of the AWS Cloud Development Kit project.
Amazon EFS provides elastic, shared file storage that is POSIX-compliant. The file system you create supports concurrent read and write access from multiple Amazon EC2 instances and is accessible from all of the Availability Zones in the AWS Region where it is created. Learn more about EFS file systems
A Virtual Private Cloud (VPC) is required to create an Amazon EFS file system.
The following example creates a file system that is encrypted at rest, running in General Purpose
performance mode, and Bursting
throughput mode and does not transition files to the Infrequent
Access (IA) storage class.
FileSystem fileSystem = FileSystem.Builder.create(this, "MyEfsFileSystem") .vpc(new Vpc(this, "VPC")) .lifecyclePolicy(LifecyclePolicy.AFTER_14_DAYS) // files are not transitioned to infrequent access (IA) storage by default .performanceMode(PerformanceMode.GENERAL_PURPOSE) // default .outOfInfrequentAccessPolicy(OutOfInfrequentAccessPolicy.AFTER_1_ACCESS) .build();
⚠️ An Amazon EFS file system's performance mode can't be changed after the file system has been created. Updating this property will replace the file system.
Any file system that has been created outside the stack can be imported into your CDK app.
Use the fromFileSystemAttributes()
API to import an existing file system.
Here is an example of giving a role write permissions on a file system.
import software.amazon.awscdk.services.iam.*; IFileSystem importedFileSystem = FileSystem.fromFileSystemAttributes(this, "existingFS", FileSystemAttributes.builder() .fileSystemId("fs-12345678") // You can also use fileSystemArn instead of fileSystemId. .securityGroup(SecurityGroup.fromSecurityGroupId(this, "SG", "sg-123456789", SecurityGroupImportOptions.builder() .allowAllOutbound(false) .build())) .build());
If you need to grant file system permissions to another resource, you can use the .grant()
API.
As an example, the following code gives elasticfilesystem:ClientWrite
permissions to an IAM role.
Role role = Role.Builder.create(this, "Role") .assumedBy(new AnyPrincipal()) .build(); fileSystem.grant(role, "elasticfilesystem:ClientWrite");
An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see Mounting a File System Using EFS Access Points.
Use the addAccessPoint
API to create an access point from a fileSystem.
fileSystem.addAccessPoint("AccessPoint");
By default, when you create an access point, the root(/
) directory is exposed to the client
connecting to the access point. You can specify a custom path with the path
property.
If path
does not exist, it will be created with the settings defined in the creationInfo
.
See Creating Access Points for more details.
Any access point that has been created outside the stack can be imported into your CDK app.
Use the fromAccessPointAttributes()
API to import an existing access point.
AccessPoint.fromAccessPointAttributes(this, "ap", AccessPointAttributes.builder() .accessPointId("fsap-1293c4d9832fo0912") .fileSystem(FileSystem.fromFileSystemAttributes(this, "efs", FileSystemAttributes.builder() .fileSystemId("fs-099d3e2f") .securityGroup(SecurityGroup.fromSecurityGroupId(this, "sg", "sg-51530134")) .build())) .build());
⚠️ Notice: When importing an Access Point using fromAccessPointAttributes()
, you must make sure
the mount targets are deployed and their lifecycle state is available
. Otherwise, you may encounter
the following error when deploying:
EFS file system
referenced by access point has mount targets created in all availability zones the function will execute in, but not all are in the available life cycle state yet. Please wait for them to become available and try the request again.
To control who can access the EFS, use the .connections
attribute. EFS has
a fixed default port, so you don't need to specify the port:
fileSystem.connections.allowDefaultPortFrom(instance);
Learn more about managing file system network accessibility
After you create a file system, you can create mount targets. Then you can mount the file system on EC2 instances, containers, and Lambda functions in your virtual private cloud (VPC).
The following example automatically mounts a file system during instance launch.
fileSystem.connections.allowDefaultPortFrom(instance); instance.userData.addCommands("yum check-update -y", "yum upgrade -y", "yum install -y amazon-efs-utils", "yum install -y nfs-utils", "file_system_id_1=" + fileSystem.getFileSystemId(), "efs_mount_point_1=/mnt/efs/fs1", "mkdir -p \"${efs_mount_point_1}\"", "test -f \"/sbin/mount.efs\" && echo \"${file_system_id_1}:/ ${efs_mount_point_1} efs defaults,_netdev\" >> /etc/fstab || " + "echo \"${file_system_id_1}.efs." + Stack.of(this).getRegion() + ".amazonaws.com:/ ${efs_mount_point_1} nfs4 nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,noresvport,_netdev 0 0\" >> /etc/fstab", "mount -a -t efs,nfs4 defaults");
Learn more about mounting EFS file systems
Since file systems are stateful resources, by default the file system will not be deleted when your stack is deleted.
You can configure the file system to be destroyed on stack deletion by setting a removalPolicy
FileSystem fileSystem = FileSystem.Builder.create(this, "EfsFileSystem") .vpc(new Vpc(this, "VPC")) .removalPolicy(RemovalPolicy.DESTROY) .build();