Manually installing the Amazon EFS client - Amazon Elastic File System
Installing the Amazon EFS client on Amazon Linux and Amazon Linux 2Installing the Amazon EFS client on other Linux distributionsInstalling the EFS client on EC2 Mac instances
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Manually installing the Amazon EFS client

You can manually install the Amazon EFS client on your Amazon EC2 Linux instances running Amazon Linux and Amazon Linux 2, and other supported Linux distributions, and on EC2 Mac instances running macOS Big Sur, macOS Monterey, and macOS Ventura. The amazon-efs-utils installation procedures for these operating systems are described in the following sections.

Installing the Amazon EFS client on Amazon Linux and Amazon Linux 2

The amazon-efs-utils package for installing on the Amazon Linux and Amazon Linux 2 is available in the following locations:

  • The Amazon Linux and Amazon Linux 2 Amazon machine image (AMI) package repositories.

  • The Amazon efs-utils GitHub repository.

The following procedure describes how to install amazon-efs-utils from the Amazon Linux and Amazon Linux 2 AMI package repositories.

You can also install or update amazon-efs-utils from the Amazon efs-utils GitHub repository. For instructions describing how to install and update the Amazon EFS client using GitHub, see To build and install amazon-efs-utils as an RPM package for Amazon Linux, Amazon Linux 2.

To install the Amazon EFS client on other Linux distributions, see Installing the Amazon EFS client on other Linux distributions.

Note

If you're using Amazon Direct Connect, you can find installation instructions in Walkthrough: Create and mount a file system on-premises with Amazon Direct Connect and VPN.

To install the amazon-efs-utils package on Amazon Linux 2 and Amazon Linux

  1. Make sure that you've created an Amazon Linux or Amazon Linux 2 EC2 instance. For information on how to do this, see Step 1: Launch an Instance in the Amazon EC2 User Guide for Linux Instances.

  2. Access the terminal for your instance through Secure Shell (SSH), and log in with the appropriate user name. For more information on how to do this, see Connecting to your Linux instance using SSH in the Amazon EC2 User Guide for Linux Instances.

  3. Run the following command to install the amazon-efs-utils package.

    sudo yum install -y amazon-efs-utils

Next steps

After installing amazon-efs-utils on your EC2 instance, proceed to the next steps for mounting your file system:

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 or Amazon Linux 2 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, Amazon Linux 2 Red Hat Linux, CentOS, and similar.

  • DEB – This package type is supported by Ubuntu, Debian, and similar.

To clone amazon-efs-utils from GitHub

  1. Connect to the EC2 instance using Secure Shell (SSH), and log in with the appropriate user name. For more information, see Connecting to Your Linux Instance Using SSH in the Amazon EC2 User Guide for Linux Instances.

  2. Install git using the following command:

    sudo yum -y install git

  3. Clone amazon-efs-utils from GitHub using the following command.

    git clone https://github.com/aws/efs-utils
To build and install the amazon-efs-utils RPM package

  1. Open a terminal on your client and navigate to the directory that contains the amazon-efs-utils package.

    cd /path/efs-utils

  2. Install the bash make command if your operating system doesn't already have it as follows.

    sudo yum -y install make

  3. Install the rpm-build package if it's not already installed using the following command:

    sudo yum -y install rpm-build

  4. Build the amazon-efs-utils package using the following command:

    sudo make rpm

  5. Install the amazon-efs-utils package with the following command.

    sudo yum -y install ./build/amazon-efs-utils*rpm

Next steps

After installing amazon-efs-utils on your EC2 instance, proceed to the next steps for mounting your file system:

To clone amazon-efs-utils from GitHub

  1. Connect to the EC2 instance using Secure Shell (SSH), and log in with the appropriate user name. For more information, see Connecting to Your Linux Instance Using SSH in the Amazon EC2 User Guide for Linux Instances.

  2. Install zypper using the following command:

    sudo zypper refresh

  3. Install the rpm-build package and the bash make command if either are not already installed using the following command:

    sudo zypper install -y git rpm-build make

    1. For OpenSUSE, if you get an error similar to the following:

      File './suse/noarch/bash-completion-2.11-2.1.noarch.rpm' not found on medium 'http://download.opensuse.org/tumbleweed/repo/oss/'

      Run the following command to re-add the repo OSS and NON-OSS.

      sudo zypper ar -f -n OSS http://download.opensuse.org/tumbleweed/repo/oss/ OSS
sudo zypper ar -f -n NON-OSS http://download.opensuse.org/tumbleweed/repo/non-oss/ NON-OSS
sudo zypper refresh

    2. Re-run the git install script again:

      sudo zypper install -y git rpm-build make

  4. Clone amazon-efs-utils from GitHub using the following command.

    git clone https://github.com/aws/efs-utils
To build and install the amazon-efs-utils RPM package

  1. Open a terminal on your client and navigate to the directory that contains the amazon-efs-utils package.

    cd /path/efs-utils

  2. Build the amazon-efs-utils package using the following command:

    make rpm

  3. Install the amazon-efs-utils package with the following command.

    sudo zypper --no-gpg-checks install -y build/amazon-efs-utils*rpm

Next steps

After installing amazon-efs-utils on your EC2 instance, proceed to the next steps for mounting your file system:

To clone amazon-efs-utils from GitHub

  1. Connect to the EC2 instance using Secure Shell (SSH), and log in with the appropriate user name. For more information, see Connecting to Your Linux Instance Using SSH in the Amazon EC2 User Guide for Linux Instances.

  2. (Optional) Apply updates before installing the package with the following command:

    sudo apt-get update

    Install updates as needed.

  3. Install git and binutils, using the following command. binutils is required for building DEB packages,

    sudo apt-get -y install git binutils

  4. Clone amazon-efs-utils from GitHub using the following command.

    git clone https://github.com/aws/efs-utils
To build and install the amazon-efs-utils DEB package

  1. Navigate to the directory that contains the amazon-efs-utils package.

    cd /path/efs-utils

  2. Build amazon-efs-utils using the following command:

    ./build-deb.sh

  3. Install the package with the following command.

    sudo apt-get -y install ./build/amazon-efs-utils*deb

Next steps

After installing amazon-efs-utils on your EC2 instance, proceed to the next steps for mounting your file system:

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.

To install the amazon-efs-utils package

  1. Make sure that you've created an EC2 Mac instance running one of the supported Mac operating systems:

    • macOS Big Sur

    • macOS Monterey

    • macOS Ventura

    For information on how to do this, see Step 1: Launch an Instance in the Amazon EC2 User Guide for Mac Instances.

  2. Access the terminal for your instance through Secure Shell (SSH), and log in with the appropriate user name. For more information on how to do this, see Connecting to your instance using SSH in the Amazon EC2 User Guide for Mac Instances.

  3. Run the following command to install amazon-efs-utils.

    brew install amazon-efs-utils
    Note

    The system responds with instructions for configuring mount helper and enabling the watchdog process, which are included in the next two steps. To view the instructions later, run the following command.

    brew info amazon-efs-utils

  4. Ensure that the EFS mount helper in amazon-efs-utils is accessible by the mount command. The command that you need to run depends on the EC2 Mac instance that you are installing the package on.

    • If you are installing the package on EC2 x86 Mac (mac1.metal), run the following command:

      sudo mkdir -p /Library/Filesystems/efs.fs/Contents/Resources
sudo ln -s /usr/local/bin/mount.efs /Library/Filesystems/efs.fs/Contents/Resources/mount_efs

    • If you are installing the package on EC2 M1 Mac (mac2.metal), run the following command:

      sudo mkdir -p /Library/Filesystems/efs.fs/Contents/Resources
sudo ln -s /opt/homebrew/bin/mount.efs /Library/Filesystems/efs.fs/Contents/Resources/mount_efs

  5. Enable the watchdog process (amazon-efs-mount-watchdog) that monitors the health of TLS mounts on your EFS file system. The command that you need to run depends on the EC2 Mac instance that you are installing the package on.

    • If you are installing the package on EC2 x86 Mac (mac1.metal), run the following command:

      sudo cp /usr/local/Cellar/amazon-efs-utils/<version>/libexec/amazon-efs-mount-watchdog.plist /Library/LaunchAgents
sudo launchctl load /Library/LaunchAgents/amazon-efs-mount-watchdog.plist

    • If you are installing the package on EC2 M1 Mac (mac2.metal), run the following command:

      sudo cp /opt/homebrew/Cellar/amazon-efs-utils/<version>/libexec/amazon-efs-mount-watchdog.plist /Library/LaunchAgents
sudo launchctl load /Library/LaunchAgents/amazon-efs-mount-watchdog.plist

Next steps

After installs amazon-efs-utils on your EC2 instance, proceed to the next steps for mounting your file system: