efs

This component is responsible for provisioning an EFS Network File System with KMS encryption-at-rest. EFS is an excellent choice as the default block storage for EKS clusters so that volumes are not zone-locked.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component.

components:
  terraform:
    efs:
      vars:
        enabled: true
        name: shared-files
        dns_name: shared-files
        provisioned_throughput_in_mibps: 10
      # additional_security_group_rules:
      #   - key: "fargate_efs"
      #     type: "ingress"
      #     from_port: 2049
      #     to_port: 2049
      #     protocol: "tcp"
      #     description: "Allow Fargate EFS Volume mounts"
      #     cidr_blocks: ["0.0.0.0/0"]

Variables

Required Variables

hostname_template (string) required: The format() string to use to generate the hostname via format(var.hostname_template, var.tenant, var.stage, var.environment)"
Typically something like "echo.%[3]v.%[2]v.example.com".
region (string) required: AWS Region

Optional Variables

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: [ ]

efs_backup_policy_enabled (bool) optional

If true, automatic backups will be enabled.

Default value: false

eks_component_names (set(string)) optional

The names of the eks components

Default value:

[
  "eks/cluster"
]

eks_security_group_enabled (bool) optional

Use the eks default security group

Default value: false

performance_mode (string) optional

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

Default value: "generalPurpose"

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

throughput_mode (string) optional

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

Default value: "bursting"

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

efs_arn: EFS ARN
efs_dns_name: EFS DNS name
efs_host: DNS hostname for the EFS
efs_id: EFS ID
efs_mount_target_dns_names: List of EFS mount target DNS names
efs_mount_target_ids: List of EFS mount target IDs (one per Availability Zone)
efs_mount_target_ips: List of EFS mount target IPs (one per Availability Zone)
efs_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.0.0
aws, version: >= 4.0

Providers

aws, version: >= 4.0

Modules

Name	Version	Source	Description
`efs`	0.35.0	`cloudposse/efs/aws`	n/a
`eks`	1.8.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`gbl_dns_delegated`	1.8.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`kms_key_efs`	0.12.1	`cloudposse/kms-key/aws`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a
`vpc`	1.8.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a

Resources

The following resources are used by this module:

Data Sources

The following data sources are used by this module:

aws_caller_identity.current (data source)
aws_iam_policy_document.kms_key_efs (data source)
aws_partition.current (data source)

References

cloudposse/terraform-aws-components - Cloud Posse's upstream component

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

References​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources

References