terraform-aws-efs

Terraform module to provision an AWS EFS Network File System.

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Usage

IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

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

module "efs" {
  source     = "git::https://github.com/cloudposse/terraform-aws-efs.git?ref=master"

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

Makefile Targets

Available targets:

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

Inputs

Name	Description	Type	Default	Required
attributes	Additional attributes (e.g. `1`)	list(string)	`<list>`	no
delimiter	Delimiter to be used between `namespace`, `stage`, `name` and `attributes`	string	`-`	no
dns_name	Name of the CNAME record to create	string	``	no
enabled	Set to false to prevent the module from creating any resources	bool	`true`	no
encrypted	If true, the file system will be encrypted	bool	`false`	no
mount_target_ip_address	The address (within the address range of the specified subnet) at which the file system may be mounted via the mount target	string	``	no
name	Name (e.g. `app`)	string	-	yes
namespace	Namespace (e.g. `eg` or `cp`)	string	``	no
performance_mode	The file system performance mode. Can be either `generalPurpose` or `maxIO`	string	`generalPurpose`	no
provisioned_throughput_in_mibps	The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with `throughput_mode` set to provisioned	string	`0`	no
region	AWS Region	string	-	yes
security_groups	Security group IDs to allow access to the EFS	list(string)	-	yes
stage	Stage (e.g. `prod`, `dev`, `staging`)	string	``	no
subnets	Subnet IDs	list(string)	-	yes
tags	Additional tags (e.g. `{ BusinessUnit = "XYZ" }`	map(string)	`<map>`	no
throughput_mode	Throughput mode for the file system. Defaults to bursting. Valid values: `bursting`, `provisioned`. When using `provisioned`, also set `provisioned_throughput_in_mibps`	string	`bursting`	no
vpc_id	VPC ID	string	-	yes
zone_id	Route53 DNS zone ID	string	``	no

Outputs

Name	Description
arn	EFS ARN
dns_name	EFS DNS name
host	Route53 DNS hostname for the EFS
id	EFS ID
mount_target_dns_names	List of EFS mount target DNS names
mount_target_ids	List of EFS mount target IDs (one per Availability Zone)
mount_target_ips	List of EFS mount target IPs (one per Availability Zone)
network_interface_ids	List of mount target network interface IDs
security_group_arn	EFS Security Group ARN
security_group_id	EFS Security Group ID
security_group_name	EFS Security Group name

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

terraform-aws-efs-backup - Terraform module designed to easily backup EFS filesystems to S3 using DataPipeline
terraform-aws-efs-cloudwatch-sns-alarms - Terraform module that configures CloudWatch SNS alerts for EFS

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

Commercial Support

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

Questions. We'll use a Shared Slack channel between your team and ours.
Troubleshooting. We'll help you triage why things aren't working.
Code Reviews. We'll review your Pull Requests and provide constructive feedback.
Bug Fixes. We'll rapidly work to fix any bugs in our projects.
Build New Terraform Modules. We'll develop original modules to provision infrastructure.
Cloud Architecture. We'll assist with your cloud strategy and design.
Implementation. We'll provide hands-on support to implement our reference architectures.

Terraform Module Development

Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.

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.

Signup for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

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

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
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!

Copyright

License

See LICENSE for full details.

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.