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.
Topics
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 AWS 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 AWS
efs-utils
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 AWS Direct Connect, you can find installation instructions in Walkthrough: Create and mount a file system on-premises with AWS Direct Connect and VPN.
To install the amazon-efs-utils
package on Amazon Linux 2 and Amazon Linux
-
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.
-
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.
-
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:
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.
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
-
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.
-
Install
git
using the following command:sudo yum -y install git
-
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
-
Open a terminal on your client and navigate to the directory that contains the
amazon-efs-utils
package.cd
/path
/efs-utils Install the bash
make
command if your operating system doesn't already have it as follows.sudo yum -y install make
-
Install the
rpm-build
package if it's not already installed using the following command:sudo yum -y install rpm-build
-
Build the
amazon-efs-utils
package using the following command:sudo make rpm
-
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:
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.
To clone amazon-efs-utils
from GitHub
-
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.
-
Install
zypper
using the following command:sudo zypper refresh
-
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
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
Re-run the git install script again:
sudo zypper install -y git rpm-build make
-
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
-
Open a terminal on your client and navigate to the directory that contains the
amazon-efs-utils
package.cd
/path
/efs-utils -
Build the
amazon-efs-utils
package using the following command:make rpm
-
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:
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.
To clone amazon-efs-utils
from GitHub
-
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.
(Optional) Apply updates before installing the package with the following command:
sudo apt-get update
Install updates as needed.
-
Install
git
andbinutils
, using the following command.binutils
is required for building DEB packages,sudo apt-get -y install git binutils
-
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
Navigate to the directory that contains the
amazon-efs-utils
package.cd
/path
/efs-utils-
Build
amazon-efs-utils
using the following command:./build-deb.sh
-
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:
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.
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
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.
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.
-
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
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
-
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:
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.