Home

Awesome

<!-- markdownlint-disable -->

<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-aws-efs/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse/terraform-aws-efs/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-efs.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a></p>

<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->

Terraform module to provision an AWS EFS Network File System.

NOTE: Release 0.32.0 contains breaking changes. To preserve the SG, follow the instructions in the 0.30.1 to 0.32.x+ migration path.

[!TIP]

πŸ‘½ Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. <br/> Works with Github Actions, Atlantis, or Spacelift.

<details> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary> <img src="https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true"/><br/> <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i> </detalis>

Usage

Include this repository as a module in your existing terraform code:

module "efs" {
  source = "cloudposse/efs/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  namespace = "eg"
  stage     = "test"
  name      = "app"
  region    = "us-west-1"
  vpc_id    = var.vpc_id
  subnets   = var.private_subnets
  zone_id   = [var.aws_route53_dns_zone_id]

  allowed_security_group_ids = [var.security_group_id]
}

[!IMPORTANT] In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

<!-- markdownlint-disable -->

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

<!-- markdownlint-restore --> <!-- markdownlint-disable -->

Requirements

NameVersion
<a name="requirement_terraform"></a> terraform>= 1.1.0
<a name="requirement_aws"></a> aws>= 5.32.0

Providers

NameVersion
<a name="provider_aws"></a> aws>= 5.32.0

Modules

NameSourceVersion
<a name="module_dns"></a> dnscloudposse/route53-cluster-hostname/aws0.13.0
<a name="module_security_group"></a> security_groupcloudposse/security-group/aws2.2.0
<a name="module_this"></a> thiscloudposse/label/null0.25.0

Resources

NameType
aws_efs_access_point.defaultresource
aws_efs_backup_policy.policyresource
aws_efs_file_system.defaultresource
aws_efs_file_system_policy.policyresource
aws_efs_mount_target.defaultresource

Inputs

NameDescriptionTypeDefaultRequired
<a name="input_access_points"></a> access_pointsA map of the access points you would like in your EFS volume<br/><br/>See [examples/complete] for an example on how to set this up.<br/>All keys are strings. The primary keys are the names of access points.<br/>The secondary keys are posix_user and creation_info.<br/>The secondary_gids key should be a comma separated value.<br/>More information can be found in the terraform resource efs_access_point.map(map(map(any))){}no
<a name="input_additional_security_group_rules"></a> additional_security_group_rulesA list of Security Group rule objects to add to the created security group, in addition to the ones<br/>this module normally creates. (To suppress the module's rules, set create_security_group to false<br/>and supply your own security group via associated_security_group_ids.)<br/>The keys and values of the objects are fully compatible with the aws_security_group_rule resource, except<br/>for security_group_id which will be ignored, and the optional "key" which, if provided, must be unique and known at "plan" time.<br/>To get more info see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule .list(any)[]no
<a name="input_additional_tag_map"></a> additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration.map(string){}no
<a name="input_allow_all_egress"></a> allow_all_egressPassed to the security group module (if one is created).booltrueno
<a name="input_allowed_cidr_blocks"></a> allowed_cidr_blocksThe CIDR blocks from which to allow ingress traffic to the EFSlist(string)[]no
<a name="input_allowed_security_group_ids"></a> allowed_security_group_idsA list of IDs of Security Groups to allow access to the security group created by this module.list(string)[]no
<a name="input_associated_security_group_ids"></a> associated_security_group_idsA list of IDs of Security Groups to associate the EFS Mount Targets with, in addition to the created security group.<br/>These security groups will not be modified and, if create_security_group is false, must have rules providing the desired access.list(string)[]no
<a name="input_attributes"></a> attributesID element. Additional attributes (e.g. workers or cluster) to add to id,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the delimiter<br/>and treated as a single ID element.list(string)[]no
<a name="input_availability_zone_name"></a> availability_zone_nameAWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. If set, a single subnet in the same availability zone should be provided to subnetsstringnullno
<a name="input_bypass_policy_lockout_safety_check"></a> bypass_policy_lockout_safety_checkA flag to indicate whether to bypass the aws_efs_file_system_policy lockout safety check.boolfalseno
<a name="input_context"></a> contextSingle object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as null to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged.any<pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre>no
<a name="input_create_security_group"></a> create_security_groupSet true to create and configure a new security group. If false, associated_security_group_ids must be provided.booltrueno
<a name="input_delimiter"></a> delimiterDelimiter to be used between ID elements.<br/>Defaults to - (hyphen). Set to "" to use no delimiter at all.stringnullno
<a name="input_descriptor_formats"></a> descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>{<br/> format = string<br/> labels = list(string)<br/>}<br/>(Type is any so the map values can later be enhanced to provide additional options.)<br/>format is a Terraform format string to be passed to the format() function.<br/>labels is a list of labels, in order, to pass to format() function.<br/>Label values will be normalized before being passed to format() so they will be<br/>identical to how they appear in id.<br/>Default is {} (descriptors output will be empty).any{}no
<a name="input_dns_name"></a> dns_nameName of the CNAME record to createstring""no
<a name="input_efs_backup_policy_enabled"></a> efs_backup_policy_enabledIf true, it will turn on automatic backups.boolfalseno
<a name="input_efs_file_system_policy"></a> efs_file_system_policyEFS policy to attach.string""no
<a name="input_enabled"></a> enabledSet to false to prevent the module from creating any resourcesboolnullno
<a name="input_encrypted"></a> encryptedIf true, the file system will be encryptedbooltrueno
<a name="input_environment"></a> environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
<a name="input_id_length_limit"></a> id_length_limitLimit id to this many characters (minimum 6).<br/>Set to 0 for unlimited length.<br/>Set to null for keep the existing setting, which defaults to 0.<br/>Does not affect id_full.numbernullno
<a name="input_kms_key_id"></a> kms_key_idIf set, use a specific KMS keystringnullno
<a name="input_label_key_case"></a> label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the tags input.<br/>Possible values: lower, title, upper.<br/>Default value: title.stringnullno
<a name="input_label_order"></a> label_orderThe order in which the labels (ID elements) appear in the id.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.list(string)nullno
<a name="input_label_value_case"></a> label_value_caseControls the letter case of ID elements (labels) as included in id,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the tags input.<br/>Possible values: lower, title, upper and none (no transformation).<br/>Set this to title and set delimiter to "" to yield Pascal Case IDs.<br/>Default value: lower.stringnullno
<a name="input_labels_as_tags"></a> labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the tags output.<br/>Set to [] to suppress all generated tags.<br/>Notes:<br/> The value of the name tag, if included, will be the id, not the name.<br/> Unlike other null-label inputs, the initial setting of labels_as_tags cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored.set(string)<pre>[<br/> "default"<br/>]</pre>no
<a name="input_mount_target_ip_address"></a> mount_target_ip_addressThe address (within the address range of the specified subnet) at which the file system may be mounted via the mount targetstringnullno
<a name="input_name"></a> nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a tag.<br/>The "name" tag is set to the full id string. There is no tag with the value of the name input.stringnullno
<a name="input_namespace"></a> namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
<a name="input_performance_mode"></a> performance_modeThe file system performance mode. Can be either generalPurpose or maxIOstring"generalPurpose"no
<a name="input_provisioned_throughput_in_mibps"></a> provisioned_throughput_in_mibpsThe throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with throughput_mode set to provisionednumber0no
<a name="input_regex_replace_chars"></a> regex_replace_charsTerraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.stringnullno
<a name="input_region"></a> regionAWS Regionstringn/ayes
<a name="input_security_group_create_before_destroy"></a> security_group_create_before_destroySet true to enable Terraform create_before_destroy behavior on the created security group.<br/>Note that changing this value will always cause the security group to be replaced.booltrueno
<a name="input_security_group_create_timeout"></a> security_group_create_timeoutHow long to wait for the security group to be created.string"10m"no
<a name="input_security_group_delete_timeout"></a> security_group_delete_timeoutHow long to retry on DependencyViolation errors during security group deletion from<br/>lingering ENIs left by certain AWS services such as Elastic Load Balancing.string"15m"no
<a name="input_security_group_description"></a> security_group_descriptionThe description to assign to the created Security Group.<br/>Warning: Changing the description causes the security group to be replaced.string"EFS Security Group"no
<a name="input_security_group_name"></a> security_group_nameThe name to assign to the created security group. Must be unique within the VPC.<br/>If not provided, will be derived from the null-label.context passed in.<br/>If create_before_destroy is true, will be used as a name prefix.list(string)[]no
<a name="input_security_groups"></a> security_groupsDEPRECATED: Use allowed_security_group_ids instead.<br/>A list of Security Group IDs to associate with EFS.list(string)[]no
<a name="input_stage"></a> stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
<a name="input_subnets"></a> subnetsSubnet IDslist(string)n/ayes
<a name="input_tags"></a> tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).<br/>Neither the tag keys nor the tag values will be modified by this module.map(string){}no
<a name="input_tenant"></a> tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
<a name="input_throughput_mode"></a> throughput_modeThroughput mode for the file system. Defaults to bursting. Valid values: bursting, provisioned. When using provisioned, also set provisioned_throughput_in_mibpsstring"bursting"no
<a name="input_transition_to_archive"></a> transition_to_archiveIndicates how long it takes to transition files to the Glacier storage class. Valid values: AFTER_1_DAY, AFTER_7_DAYS, AFTER_14_DAYS, AFTER_30_DAYS, AFTER_60_DAYS, AFTER_90_DAYS, AFTER_180_DAYS, AFTER_270_DAYS and AFTER_365_DAYS. Default (no value) means "never".list(string)[]no
<a name="input_transition_to_ia"></a> transition_to_iaIndicates how long it takes to transition files to the Infrequent Access (IA) storage class. Valid values: AFTER_1_DAY, AFTER_7_DAYS, AFTER_14_DAYS, AFTER_30_DAYS, AFTER_60_DAYS, AFTER_90_DAYS, AFTER_180_DAYS, AFTER_270_DAYS and AFTER_365_DAYS. Default (no value) means "never".list(string)[]no
<a name="input_transition_to_primary_storage_class"></a> transition_to_primary_storage_classDescribes the policy used to transition a file from Infrequent Access (IA) storage to primary storage. Valid values: AFTER_1_ACCESS.list(string)[]no
<a name="input_vpc_id"></a> vpc_idVPC IDstringn/ayes
<a name="input_zone_id"></a> zone_idRoute53 DNS Zone ID as list of string (0 or 1 items). If empty, no custom DNS name will be published.<br/>If the list contains a single Zone ID, a custom DNS name will be pulished in that zone.<br/>Can also be a plain string, but that use is DEPRECATED because of Terraform issues.list(string)[]no

Outputs

NameDescription
<a name="output_access_point_arns"></a> access_point_arnsEFS AP ARNs
<a name="output_access_point_ids"></a> access_point_idsEFS AP ids
<a name="output_arn"></a> arnEFS ARN
<a name="output_dns_name"></a> dns_nameEFS DNS name
<a name="output_host"></a> hostRoute53 DNS hostname for the EFS
<a name="output_id"></a> idEFS ID
<a name="output_mount_target_dns_names"></a> mount_target_dns_namesList of EFS mount target DNS names
<a name="output_mount_target_ids"></a> mount_target_idsList of EFS mount target IDs (one per Availability Zone)
<a name="output_mount_target_ips"></a> mount_target_ipsList of EFS mount target IPs (one per Availability Zone)
<a name="output_network_interface_ids"></a> network_interface_idsList of mount target network interface IDs
<a name="output_security_group_arn"></a> security_group_arnEFS Security Group ARN
<a name="output_security_group_id"></a> security_group_idEFS Security Group ID
<a name="output_security_group_name"></a> security_group_nameEFS Security Group name
<!-- markdownlint-restore -->

Related Projects

Check out these related projects.

[!TIP]

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

βœ… We build it together with your team.<br/> βœ… Your team owns everything.<br/> βœ… 100% Open Source and backed by fanatical support.<br/>

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-efs&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

<details><summary>πŸ“š <strong>Learn More</strong></summary> <br/>

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-efs&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

Day-2: Your Operational Mastery

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-efs&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

</details>

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

<a href="https://github.com/cloudposse/terraform-aws-efs/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-efs&max=24" /> </a>

For πŸ› bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

πŸ“° Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week β€” and usually a 5-minute read.

πŸ“† Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-efs&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>

<details> <summary>Preamble to the Apache License, Version 2.0</summary> <br/> <br/>

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
</details>

Trademarks

All other trademarks referenced herein are the property of their respective owners.


Copyright Β© 2017-2024 Cloud Posse, LLC

<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-efs&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>

<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-aws-efs?pixel&cs=github&cm=readme&an=terraform-aws-efs"/>