CINXE.COM
Installing the Amazon EFS client - Amazon Elastic File System
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Installing the Amazon EFS client - Amazon Elastic File System</title><meta name="viewport" content="width=device-width,initial-scale=1" /><meta name="assets_root" content="/assets" /><meta name="target_state" content="using-amazon-efs-utils" /><meta name="default_state" content="using-amazon-efs-utils" /><link rel="icon" type="image/ico" href="/assets/images/favicon.ico" /><link rel="shortcut icon" type="image/ico" href="/assets/images/favicon.ico" /><link rel="canonical" href="https://docs.aws.amazon.com/efs/latest/ug/using-amazon-efs-utils.html" /><meta name="description" content="Download, and install the EFS client (amazon-efs-utils) to use the EFS mount helper, to monitor mount status with Amazon CloudWatch, and to more easily encrypt data in transit." /><meta name="deployment_region" content="IAD" /><meta name="product" content="Amazon Elastic File System" /><meta name="guide" content="User Guide" /><meta name="abstract" content="Use Amazon Elastic File System (Amazon EFS) to set up, operate, and scale shared file storage in the Amazon Web Services (AWS) cloud." /><meta name="guide-locale" content="en_us" /><meta name="tocs" content="toc-contents.json" /><link rel="canonical" href="https://docs.aws.amazon.com/efs/latest/ug/using-amazon-efs-utils.html" /><link rel="alternative" href="https://docs.aws.amazon.com/id_id/efs/latest/ug/using-amazon-efs-utils.html" hreflang="id-id" /><link rel="alternative" href="https://docs.aws.amazon.com/id_id/efs/latest/ug/using-amazon-efs-utils.html" hreflang="id" /><link rel="alternative" href="https://docs.aws.amazon.com/de_de/efs/latest/ug/using-amazon-efs-utils.html" hreflang="de-de" /><link rel="alternative" href="https://docs.aws.amazon.com/de_de/efs/latest/ug/using-amazon-efs-utils.html" hreflang="de" /><link rel="alternative" href="https://docs.aws.amazon.com/efs/latest/ug/using-amazon-efs-utils.html" hreflang="en-us" /><link rel="alternative" href="https://docs.aws.amazon.com/efs/latest/ug/using-amazon-efs-utils.html" hreflang="en" /><link rel="alternative" href="https://docs.aws.amazon.com/es_es/efs/latest/ug/using-amazon-efs-utils.html" hreflang="es-es" /><link rel="alternative" href="https://docs.aws.amazon.com/es_es/efs/latest/ug/using-amazon-efs-utils.html" hreflang="es" /><link rel="alternative" href="https://docs.aws.amazon.com/fr_fr/efs/latest/ug/using-amazon-efs-utils.html" hreflang="fr-fr" /><link rel="alternative" href="https://docs.aws.amazon.com/fr_fr/efs/latest/ug/using-amazon-efs-utils.html" hreflang="fr" /><link rel="alternative" href="https://docs.aws.amazon.com/it_it/efs/latest/ug/using-amazon-efs-utils.html" hreflang="it-it" /><link rel="alternative" href="https://docs.aws.amazon.com/it_it/efs/latest/ug/using-amazon-efs-utils.html" hreflang="it" /><link rel="alternative" href="https://docs.aws.amazon.com/ja_jp/efs/latest/ug/using-amazon-efs-utils.html" hreflang="ja-jp" /><link rel="alternative" href="https://docs.aws.amazon.com/ja_jp/efs/latest/ug/using-amazon-efs-utils.html" hreflang="ja" /><link rel="alternative" href="https://docs.aws.amazon.com/ko_kr/efs/latest/ug/using-amazon-efs-utils.html" hreflang="ko-kr" /><link rel="alternative" href="https://docs.aws.amazon.com/ko_kr/efs/latest/ug/using-amazon-efs-utils.html" hreflang="ko" /><link rel="alternative" href="https://docs.aws.amazon.com/pt_br/efs/latest/ug/using-amazon-efs-utils.html" hreflang="pt-br" /><link rel="alternative" href="https://docs.aws.amazon.com/pt_br/efs/latest/ug/using-amazon-efs-utils.html" hreflang="pt" /><link rel="alternative" href="https://docs.aws.amazon.com/zh_cn/efs/latest/ug/using-amazon-efs-utils.html" hreflang="zh-cn" /><link rel="alternative" href="https://docs.aws.amazon.com/zh_tw/efs/latest/ug/using-amazon-efs-utils.html" hreflang="zh-tw" /><link rel="alternative" href="https://docs.aws.amazon.com/efs/latest/ug/using-amazon-efs-utils.html" hreflang="x-default" /><meta name="feedback-item" content="EFS" /><meta name="this_doc_product" content="Amazon Elastic File System" /><meta name="this_doc_guide" content="User Guide" /><script defer="" src="/assets/r/vendor4.js?version=2021.12.02"></script><script defer="" src="/assets/r/vendor3.js?version=2021.12.02"></script><script defer="" src="/assets/r/vendor1.js?version=2021.12.02"></script><script defer="" src="/assets/r/awsdocs-common.js?version=2021.12.02"></script><script defer="" src="/assets/r/awsdocs-doc-page.js?version=2021.12.02"></script><link href="/assets/r/vendor4.css?version=2021.12.02" rel="stylesheet" /><link href="/assets/r/awsdocs-common.css?version=2021.12.02" rel="stylesheet" /><link href="/assets/r/awsdocs-doc-page.css?version=2021.12.02" rel="stylesheet" /><script async="" id="awsc-panorama-bundle" type="text/javascript" src="https://prod.pa.cdn.uis.awsstatic.com/panorama-nav-init.js" data-config="{'appEntity':'aws-documentation','region':'us-east-1','service':'efs'}"></script><meta id="panorama-serviceSubSection" value="User Guide" /><meta id="panorama-serviceConsolePage" value="Installing the Amazon EFS client" /></head><body class="awsdocs awsui"><div class="awsdocs-container"><awsdocs-header></awsdocs-header><awsui-app-layout id="app-layout" class="awsui-util-no-gutters" ng-controller="ContentController as $ctrl" header-selector="awsdocs-header" navigation-hide="false" navigation-width="$ctrl.navWidth" navigation-open="$ctrl.navOpen" navigation-change="$ctrl.onNavChange($event)" tools-hide="$ctrl.hideTools" tools-width="$ctrl.toolsWidth" tools-open="$ctrl.toolsOpen" tools-change="$ctrl.onToolsChange($event)"><div id="guide-toc" dom-region="navigation"><awsdocs-toc></awsdocs-toc></div><div id="main-column" dom-region="content" tabindex="-1"><awsdocs-view class="awsdocs-view"><div id="awsdocs-content"><head><title>Installing the Amazon EFS client - Amazon Elastic File System</title><meta name="pdf" content="/pdfs/efs/latest/ug/efs-ug.pdf#using-amazon-efs-utils" /><meta name="rss" content="amazon-efs-doc-updates.rss" /><meta name="forums" content="https://repost.aws/tags/TAmTqmXysORgKO6xcE3oh0MA" /><meta name="feedback" content="https://docs.aws.amazon.com/forms/aws-doc-feedback?hidden_service_name=EFS&topic_url=https://docs.aws.amazon.com/en_us/efs/latest/ug/using-amazon-efs-utils.html" /><meta name="feedback-yes" content="feedbackyes.html?topic_url=https://docs.aws.amazon.com/en_us/efs/latest/ug/using-amazon-efs-utils.html" /><meta name="feedback-no" content="feedbackno.html?topic_url=https://docs.aws.amazon.com/en_us/efs/latest/ug/using-amazon-efs-utils.html" /><meta name="keywords" content="EFS,Elastic File System,elastic,storage service,amazon-efs-utils,EFS client" /><script type="application/ld+json"> { "@context" : "https://schema.org", "@type" : "BreadcrumbList", "itemListElement" : [ { "@type" : "ListItem", "position" : 1, "name" : "AWS", "item" : "https://aws.amazon.com" }, { "@type" : "ListItem", "position" : 2, "name" : "Amazon Elastic File System (EFS)", "item" : "https://docs.aws.amazon.com/efs/index.html" }, { "@type" : "ListItem", "position" : 3, "name" : "User Guide", "item" : "https://docs.aws.amazon.com/efs/latest/ug" }, { "@type" : "ListItem", "position" : 4, "name" : "Installing the Amazon EFS client", "item" : "https://docs.aws.amazon.com/efs/latest/ug/using-amazon-efs-utils.html" } ] } </script></head><body><div id="main"><div style="display: none"><a href="/pdfs/efs/latest/ug/efs-ug.pdf#using-amazon-efs-utils" target="_blank" rel="noopener noreferrer" title="Open PDF"></a></div><div id="breadcrumbs" class="breadcrumb"><a href="/index.html">Documentation</a><a href="/efs/index.html">Amazon Elastic File System (EFS)</a><a href="whatisefs.html">User Guide</a></div><div id="page-toc-src"><a href="#utils-dependencies">Dependencies for EFS tools</a><a href="#efs-utils-supported-distros">Supported distributions</a></div><div id="main-content" class="awsui-util-container"><div id="main-col-body"><awsdocs-language-banner data-service="$ctrl.pageService"></awsdocs-language-banner><h1 class="topictitle" id="using-amazon-efs-utils">Installing the Amazon EFS client</h1><div class="awsdocs-page-header-container"><awsdocs-page-header></awsdocs-page-header><awsdocs-filter-selector id="awsdocs-filter-selector"></awsdocs-filter-selector></div><p>We recommend that you install the Amazon EFS client (<code>amazon-efs-utils</code>), an open-source collection of tools for Amazon EFS. The Amazon EFS client includes a <em>mount helper</em>, which is a program that helps simplify mounting EFS file systems. The client also enables the ability to use Amazon CloudWatch to monitor an EFS file system's mount status, and it includes tooling that makes it easier to perform encryption of data in transit for Amazon EFS file systems. </p><p>You can manually install the Amazon EFS client on Amazon EC2 instances running <a href="#efs-utils-supported-distros">supported distributions</a>. For certain supported operating systems, you can alternatively configure AWS Systems Manager to automatically install or update the package. For a list of distributions that you can use with AWS Systems Manager, see <a href="./manage-efs-utils-with-aws-sys-manager.html#sys-mgr-support-matrix">Systems Manager Distributor supported operating systems</a>.</p><div class="highlights"><h6>Topics</h6><ul><li><a href="#utils-dependencies">Dependencies for EFS tools</a></li><li><a href="#efs-utils-supported-distros">Supported distributions</a></li><li><a href="./installing-amazon-efs-utils.html">Manually installing the Amazon EFS client</a></li><li><a href="./manage-efs-utils-with-aws-sys-manager.html">Automatically installing or updating Amazon EFS client using AWS Systems Manager</a></li><li><a href="./install-botocore.html">Installing and upgrading botocore</a></li><li><a href="./upgrading-stunnel.html">Upgrading stunnel</a></li></ul></div> <h2 id="utils-dependencies">Dependencies for EFS tools</h2> <p>The following dependencies exist for <code>amazon-efs-utils</code> and are installed when you install the <code>amazon-efs-utils</code> package:</p> <div class="itemizedlist"> <ul class="itemizedlist"><li class="listitem"> <p>NFS client</p> <div class="itemizedlist"> <ul class="itemizedlist"><li class="listitem"><p><code>nfs-utils</code> for RHEL, CentOS, Amazon Linux, and Fedora distributions</p></li><li class="listitem"><p><code>nfs-common</code> for Debian and Ubuntu distributions</p></li></ul></div> </li><li class="listitem"> <p>Network relay (stunnel package, version 4.56 or later)</p> </li><li class="listitem"> <p>Python (version 3.4 or later)</p> </li><li class="listitem"> <p>OpenSSL 1.0.2 or newer</p> </li></ul></div> <div class="awsdocs-note"><div class="awsdocs-note-title"><awsui-icon name="status-info" variant="link"></awsui-icon><h6>Note</h6></div><div class="awsdocs-note-text"><p>By default, when using the EFS mount helper with Transport Layer Security (TLS), the mount helper enforces certificate hostname checking. The EFS mount helper uses the <code>stunnel</code> program for its TLS functionality. Some versions of Linux don't include a version of <code>stunnel</code> that supports these TLS features by default. When using one of those Linux versions, mounting an EFS file system using TLS fails.</p></div></div> <p>After you've installed the <code>amazon-efs-utils</code> package, upgrade stunnel. See <a href="./upgrading-stunnel.html">Upgrading stunnel</a>.</p> <p>You can use AWS Systems Manager to manage Amazon EFS clients and automate the tasks required to install or update the amazon-efs-utils package on your EC2 instances. For more information, see <a href="./manage-efs-utils-with-aws-sys-manager.html">Automatically installing or updating Amazon EFS client using AWS Systems Manager</a>.</p> <p>For issues with encryption, see <a href="./troubleshooting-efs-encryption.html">Troubleshooting encryption</a>.</p> <h2 id="efs-utils-supported-distros">Supported distributions</h2> <p>The Amazon EFS client has been verified against the following Linux and Mac distributions:</p> <div class="table-container"><div class="table-contents"><table id="w244aac13c11b5"><thead> <tr><th>Distribution</th><th>Package type</th><th><code class="code">init</code> system</th></tr> </thead> <tr> <td tabindex="-1">Amazon Linux 2023 (AL2023)</td> <td tabindex="-1">rpm</td> <td tabindex="-1"><code class="code">systemd</code></td> </tr> <tr><td tabindex="-1">Amazon Linux 2 (AL2)</td><td tabindex="-1">rpm</td><td tabindex="-1"><code class="code">systemd</code></td></tr> <tr><td tabindex="-1">CentOS 8</td><td tabindex="-1">rpm</td><td tabindex="-1"><code class="code">systemd</code></td></tr> <tr> <td tabindex="-1">Amazon Linux (AL1) 2017.09<div class="awsdocs-note"><div class="awsdocs-note-title"><awsui-icon name="status-info" variant="link"></awsui-icon><h6>Note</h6></div><div class="awsdocs-note-text"><p>Amazon Linux (AL1) AMI reached its end-of-life on December 31, 2023 and is not supported for <code>amazon-efs-utils</code> packages released in April 2024 or later (version 2.0 and later). </p></div></div></td> <td tabindex="-1">rpm</td> <td tabindex="-1"><code class="code">upstart</code></td> </tr> <tr><td tabindex="-1">Debian 11</td><td tabindex="-1">deb</td><td tabindex="-1"><code class="code">systemd</code></td></tr> <tr><td tabindex="-1">Fedora 29 - 32</td><td tabindex="-1">rpm</td><td tabindex="-1"><code class="code">systemd</code></td></tr> <tr><td tabindex="-1">macOS Big Sur</td><td tabindex="-1"></td><td tabindex="-1"><code class="code">launchd</code></td></tr> <tr><td tabindex="-1">macOS Monterey</td><td tabindex="-1"></td><td tabindex="-1"><code class="code">launchd</code></td></tr> <tr> <td tabindex="-1">macOS Ventura</td> <td tabindex="-1"></td> <td tabindex="-1"><code class="code">launchd</code></td> </tr> <tr> <td tabindex="-1">macOS Sonoma</td> <td tabindex="-1"></td> <td tabindex="-1"><code class="code">launchd</code></td> </tr> <tr><td tabindex="-1">OpenSUSE Leap, Tumbleweed</td><td tabindex="-1">rpm</td><td tabindex="-1"><code class="code">systemd</code></td></tr> <tr> <td tabindex="-1">Oracle8</td> <td tabindex="-1">rpm</td> <td tabindex="-1"><code class="code">systemd</code></td> </tr> <tr><td tabindex="-1">Red Hat Enterprise Linux (RHEL) 7, 8, 9</td><td tabindex="-1">rpm</td><td tabindex="-1"><code class="code">systemd</code></td></tr> <tr><td tabindex="-1">SUSE Linux Enterprise Server (SLES) 12, 15</td><td tabindex="-1">rpm</td><td tabindex="-1"><code class="code">systemd</code></td></tr> <tr><td tabindex="-1">Ubuntu 16.04 LTS, 18.04 LTS, 20.04 LTS, 22.04 LTS</td><td tabindex="-1">deb</td><td tabindex="-1"><code class="code">systemd</code></td></tr> </table></div></div> <p>For a complete list of supported distributions that the package has been verified against, see the <code>amazon-efs-utils</code> <a href="https://github.com/aws/efs-utils/blob/master/README.md" rel="noopener noreferrer" target="_blank"><span>README</span><awsui-icon class="awsdocs-link-icon" name="external"></awsui-icon></a> on Github.</p> <awsdocs-copyright class="copyright-print"></awsdocs-copyright><awsdocs-thumb-feedback right-edge="{{$ctrl.thumbFeedbackRightEdge}}"></awsdocs-thumb-feedback></div><noscript><div><div><div><div id="js_error_message"><p><img src="https://d1ge0kk1l5kms0.cloudfront.net/images/G/01/webservices/console/warning.png" alt="Warning" /> <strong>Javascript is disabled or is unavailable in your browser.</strong></p><p>To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.</p></div></div></div></div></noscript><div id="main-col-footer" class="awsui-util-font-size-0"><div id="doc-conventions"><a target="_top" href="/general/latest/gr/docconventions.html">Document Conventions</a></div><div class="prev-next"><div id="previous" class="prev-link" accesskey="p" href="./accessing-fs-nfs-permissions-per-user-subdirs.html">Tutorial: Creating writable per-user subdirectories</div><div id="next" class="next-link" accesskey="n" href="./installing-amazon-efs-utils.html">Manually installing the EFS client</div></div></div><awsdocs-page-utilities></awsdocs-page-utilities></div><div id="quick-feedback-yes" style="display: none;"><div class="title">Did this page help you? - Yes</div><div class="content"><p>Thanks for letting us know we're doing a good job!</p><p>If you've got a moment, please tell us what we did right so we can do more of it.</p><p><awsui-button id="fblink" rel="noopener noreferrer" target="_blank" text="Feedback" click="linkClick($event)" href="https://docs.aws.amazon.com/forms/aws-doc-feedback?hidden_service_name=EFS&topic_url=https://docs.aws.amazon.com/en_us/efs/latest/ug/using-amazon-efs-utils.html"></awsui-button></p></div></div><div id="quick-feedback-no" style="display: none;"><div class="title">Did this page help you? - No</div><div class="content"><p>Thanks for letting us know this page needs work. We're sorry we let you down.</p><p>If you've got a moment, please tell us how we can make the documentation better.</p><p><awsui-button id="fblink" rel="noopener noreferrer" target="_blank" text="Feedback" click="linkClick($event)" href="https://docs.aws.amazon.com/forms/aws-doc-feedback?hidden_service_name=EFS&topic_url=https://docs.aws.amazon.com/en_us/efs/latest/ug/using-amazon-efs-utils.html"></awsui-button></p></div></div></div></body></div></awsdocs-view><div class="page-loading-indicator" id="page-loading-indicator"><awsui-spinner size="large"></awsui-spinner></div></div><div id="tools-panel" dom-region="tools"><awsdocs-tools-panel id="awsdocs-tools-panel"></awsdocs-tools-panel></div></awsui-app-layout><awsdocs-cookie-banner class="doc-cookie-banner"></awsdocs-cookie-banner></div></body></html>