README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-aws-efs

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - networking
  - efs
  - nfs

# Categories of this project
categories:
  - terraform-modules/networking

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-efs

# Badges to display
badges:
  - name: "Build Status"
    image: "https://travis-ci.org/cloudposse/terraform-aws-efs.svg?branch=master"
    url: "https://travis-ci.org/cloudposse/terraform-aws-efs"
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-efs.svg"
    url: "https://github.com/cloudposse/terraform-aws-efs/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related:
  - name: "terraform-aws-efs-backup"
    description: "Terraform module designed to easily backup EFS filesystems to S3 using DataPipeline"
    url: "https://github.com/cloudposse/terraform-aws-efs-backup"
  - name: "terraform-aws-efs-cloudwatch-sns-alarms"
    description: "Terraform module that configures CloudWatch SNS alerts for EFS"
    url: "https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms"
# Short description of this project
description: |-
  Terraform module to provision an AWS [`EFS`](https://aws.amazon.com/efs/) Network File System.

# How to use this project
usage: |-
  Include this repository as a module in your existing terraform code:

  ```hcl
  module "efs" {
    source     = "git::https://github.com/cloudposse/terraform-aws-efs.git?ref=master"
    namespace  = "global"
    name       = "app"
    stage      = "prod"
    attributes = ["efs"]

    aws_region         = "${var.aws_region}"
    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}"
  }
  ```

include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors:
  - name: "Igor Rodionov"
    github: "goruha"
  - name: "Andriy Knysh"
    github: "aknysh"
  - name: "Sergey Vasilyev"
    github: "s2504s"
  - name: "Mike Eirih"
    github: "maokomioko"