Skip to main content

Module: efs

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.

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]
}

Variables​

Required Variables​

region (string) required​

AWS Region

subnets (list(string)) required​

Subnet IDs

vpc_id (string) required​

VPC ID

Optional Variables​

access_points (map(map(map(any)))) optional​

A map of the access points you would like in your EFS volume


See [examples/complete] for an example on how to set this up.
All keys are strings. The primary keys are the names of access points.
The secondary keys are posix_user and creation_info.
The secondary_gids key should be a comma separated value.
More information can be found in the terraform resource efs_access_point.



Default value: { }

additional_security_group_rules (list(any)) optional​

A list of Security Group rule objects to add to the created security group, in addition to the ones
this module normally creates. (To suppress the module's rules, set create_security_group to false
and supply your own security group via associated_security_group_ids.)
The keys and values of the objects are fully compatible with the aws_security_group_rule resource, except
for security_group_id which will be ignored, and the optional "key" which, if provided, must be unique and known at "plan" time.
To get more info see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule .



Default value: [ ]

allow_all_egress (bool) optional​

Passed to the security group module (if one is created).



Default value: true

allowed_cidr_blocks (list(string)) optional​

The CIDR blocks from which to allow ingress traffic to the EFS


Default value: [ ]

allowed_ipv6_cidr_blocks (list(string)) optional​

List of IPv6 CIDR blocks allowed to access the cluster


Default value: [ ]

allowed_security_group_ids (list(string)) optional​

A list of IDs of Security Groups to allow access to the security group created by this module.



Default value: [ ]

associated_security_group_ids (list(string)) optional​

A list of IDs of Security Groups to associate the EFS Mount Targets with, in addition to the created security group.
These security groups will not be modified and, if create_security_group is false, must have rules providing the desired access.



Default value: [ ]

availability_zone_name (string) optional​

AWS 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 subnets


Default value: null

bypass_policy_lockout_safety_check (bool) optional​

A flag to indicate whether to bypass the aws_efs_file_system_policy lockout safety check.


Default value: false

create_security_group (bool) optional​

Set true to create and configure a new security group. If false, associated_security_group_ids must be provided.


Default value: true

dns_name (string) optional​

Name of the CNAME record to create


Default value: ""

efs_backup_policy_enabled (bool) optional​

If true, it will turn on automatic backups.


Default value: false

efs_file_system_policy (string) optional​

EFS policy to attach.


Default value: ""

encrypted (bool) optional​

If true, the file system will be encrypted


Default value: true

kms_key_id (string) optional​

If set, use a specific KMS key


Default value: null

mount_target_ip_address (string) optional​

The address (within the address range of the specified subnet) at which the file system may be mounted via the mount target


Default value: null

mount_target_ip_address_type (string) optional​

IP address type for the mount target. Valid values are IPV4_ONLY (only IPv4 addresses), IPV6_ONLY (only IPv6 addresses), and DUAL_STACK (dual-stack, both IPv4 and IPv6 addresses). Defaults to IPV4_ONLY.


Default value: "IPV4_ONLY"

mount_target_ipv6_address (string) optional​

IPv6 address to use. Valid only when mount_target_ip_address_type is set to IPV6_ONLY or DUAL_STACK.


Default value: null

performance_mode (string) optional​

The file system performance mode. Can be either generalPurpose or maxIO


Default value: "generalPurpose"

preserve_security_group_id (bool) optional​

If true, instruct the underlying security group module to attempt to preserve
the security group ID across rule changes. See the upstream CloudPosse
terraform-aws-security-group module README for details and caveats.



Default value: false

provisioned_throughput_in_mibps (number) optional​

The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with throughput_mode set to provisioned


Default value: 0

security_group_create_before_destroy (bool) optional​

Set true to enable Terraform create_before_destroy behavior on the created security group.
Note that changing this value will always cause the security group to be replaced.



Default value: true

security_group_create_timeout (string) optional​

How long to wait for the security group to be created.


Default value: "10m"

security_group_delete_timeout (string) optional​

How long to retry on DependencyViolation errors during security group deletion from
lingering ENIs left by certain AWS services such as Elastic Load Balancing.



Default value: "15m"

security_group_description (string) optional​

The description to assign to the created Security Group.
Warning: Changing the description causes the security group to be replaced.



Default value: "EFS Security Group"

security_group_name (list(string)) optional​

The name to assign to the created security group. Must be unique within the VPC.
If not provided, will be derived from the null-label.context passed in.
If create_before_destroy is true, will be used as a name prefix.



Default value: [ ]

security_groups (list(string)) optional​

DEPRECATED: Use allowed_security_group_ids instead.
A list of Security Group IDs to associate with EFS.



Default value: [ ]

throughput_mode (string) optional​

Throughput mode for the file system. Defaults to bursting. Valid values: bursting, provisioned, elastic. When using provisioned, also set provisioned_throughput_in_mibps


Default value: "bursting"

transition_to_archive (list(string)) optional​

Indicates 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".


Default value: [ ]

transition_to_ia (list(string)) optional​

Indicates 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".


Default value: [ ]

transition_to_primary_storage_class (list(string)) optional​

Describes the policy used to transition a file from Infrequent Access (IA) storage to primary storage. Valid values: AFTER_1_ACCESS.


Default value: [ ]

zone_id (list(string)) optional​

Route53 DNS Zone ID as list of string (0 or 1 items). If empty, no custom DNS name will be published.
If the list contains a single Zone ID, a custom DNS name will be pulished in that zone.
Can also be a plain string, but that use is DEPRECATED because of Terraform issues.



Default value: [ ]

Context Variables​

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional​

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.


Required: No

Default value: { }

attributes (list(string)) optional​

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.


Required: No

Default value: [ ]

context (any) optional​

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.


Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
delimiter (string) optional​

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.


Required: No

Default value: null

descriptor_formats (any) optional​

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).


Required: No

Default value: { }

enabled (bool) optional​

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional​

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional​

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.


Required: No

Default value: null

label_key_case (string) optional​

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.


Required: No

Default value: null

label_order (list(string)) optional​

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.


Required: No

Default value: null

label_value_case (string) optional​

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.


Required: No

Default value: null

labels_as_tags (set(string)) optional​

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.


Required: No

Default value:

[
  "default"
]
name (string) optional​

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.


Required: No

Default value: null

namespace (string) optional​

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional​

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.


Required: No

Default value: null

stage (string) optional​

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional​

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.


Required: No

Default value: { }

tenant (string) optional​

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs​

access_point_arns​

EFS AP ARNs

access_point_ids​

EFS AP ids

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)

mount_target_ipv6_addresses​

List of EFS mount target IPv6 addresses (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

Dependencies​

Requirements​

  • terraform, version: >= 1.1.0
  • aws, version: >= 5.32.0

Providers​

  • aws, version: >= 5.32.0

Modules​

NameVersionSourceDescription
dns0.13.0cloudposse/route53-cluster-hostname/awsn/a
security_group2.2.0cloudposse/security-group/awsn/a
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: