Manually installing the Amazon EFS client
You can manually install the Amazon EFS client on Amazon EC2 Linux instances and on EC2 Mac instances running macOS Big Sur, macOS Monterey, and macOS Ventura. For a list of the distributions that support Amazon EFS client, see Supported distributions
The installation procedures for supported operating systems are described in the following sections.
Topics
Installing the Amazon EFS client on Amazon EC2 Linux instances
The amazon-efs-utils
package for installing on Amazon EC2 Linux instances
from the following locations:
-
The Amazon machine image (AMI) package repositories for Amazon Linux. The following instructions are for installing the
amazon-efs-utils
package from the AMI package repositories. The AWS efs-utils
GitHub repository. For more information about installing the amazon-efs-utils
package from GitHub, see Installing the Amazon EFS client on other Linux distributions.
Note
If you're using AWS Direct Connect, you can find installation instructions in Prerequisites.
-
The Amazon Linux (AL1) AMI reached its end-of-life on December 31, 2023 and is not supported for
amazon-efs-utils
packages released in April 2024 and later (version 2.0 and later). We recommend that you upgrade applications toAmazon Linux 2023 (AL2023), which includes long-term support until 2028.
To install the amazon-efs-utils
package from the AMI package repository
on Amazon EC2 Linux instances
-
Make sure that you've created an AL2023, Amazon Linux 2 (AL2), or Amazon Linux (AL1) EC2 instance. For information on how to do this, see Step 1: Launch an instance.
-
Access the terminal for your instance through Secure Shell (SSH), and log in with the appropriate user name. For more information, see Connect to your EC2 instance in the Amazon EC2 User Guide.
-
Run the following command to install the
amazon-efs-utils
package.sudo yum install -y amazon-efs-utils
Installing the Amazon EFS client on other Linux distributions
If you don't want to get the amazon-efs-utils
package from the Amazon Linux AMI
package repositories, it is also available on GitHub.
After you clone the package, you can build and install amazon-efs-utils
using one of the
following methods, depending on the package type supported by your Linux distribution:
-
RPM – This package type is supported by Amazon Linux 2023 (AL2023), Amazon Linux 2 (AL2), Amazon Linux (AL1), Red Hat Linux, CentOS, and similar.
-
DEB – This package type is supported by Ubuntu, Debian, and similar.
For instructions on installing the amazon-efs-utils
package for other
Linux distributions, see On other
Linux distributionsamazon-efs-utils
README on
Github.
Installing the Amazon EFS client on EC2 Mac instances running macOS Big Sur, macOS Monterey, or macOS Ventura
The amazon-efs-utils
package is available for installation on EC2 Mac
instances running macOS Big Sur, macOS Monterey, or macOS Ventura.
For instructions on installing the amazon-efs-utils
package on Mac
instances, see On MacOS Big Sur, macOS Monterey, macOS Sonoma and macOS Ventura distribution amazon-efs-utils
README on Github.
Next steps
After installs amazon-efs-utils
on your EC2 instance, proceed to the next steps for mounting your file system:
Install botocore so that you can use Amazon CloudWatch to monitor your file system's mount status.
Upgrade to the latest version of stunnel to enable encryption of data in transit.
Mount your file system using the EFS mount helper.