This module will build and configure an EFS file system
This repository is a READ-ONLY sub-tree split. See https://github.com/FriendsOfTerraform/modules to create issues or submit pull requests.
module "demo_efs" {
source = "github.com/FriendsOfTerraform/aws-efs.git?ref=v1.0.0"
name = "demo-efs"
# Configures multiple mount targets
mount_targets = {
# The key of the map is the subnet ID to create the mount target on
"subnet-02cd47a492abcdef0" = { security_group_ids = ["sg-00ce17020babcdef0"] } # us-east-1a
"subnet-0f44f4247babcdef0" = { security_group_ids = ["sg-00ce17020babcdef0"] } # us-east-1b
}
}module "demo_efs" {
source = "github.com/FriendsOfTerraform/aws-efs.git?ref=v1.0.0"
name = "demo-efs"
# You must have at least 1 mount target to create access points
# Configures multiple mount targets
mount_targets = {
# The key of the map is the subnet ID to create the mount target on
"subnet-02cd47a492abcdef0" = { security_group_ids = ["sg-00ce17020babcdef0"] } # us-east-1a
"subnet-0f44f4247babcdef0" = { security_group_ids = ["sg-00ce17020babcdef0"] } # us-east-1b
}
# Configures multiple access points
access_points = {
# The key of the map will be the name of the access point
"web-frontend" = {
posix_user = {
group_id = 10001
user_id = 10001
}
root_directory_creation_permissions = {
owner_group_id = 10001
owner_user_id = 10001
access_point_permissions = "0774"
}
root_directory_path = "/web"
}
"database" = {
posix_user = {
group_id = 10002
user_id = 10002
}
root_directory_creation_permissions = {
owner_group_id = 10002
owner_user_id = 10002
access_point_permissions = "0770"
}
root_directory_path = "/sql"
}
"scratch" = {
root_directory_path = "/scratch"
}
}
}module "demo_efs" {
source = "github.com/FriendsOfTerraform/aws-efs.git?ref=v1.0.0"
name = "demo-efs"
# Configures multiple mount targets
mount_targets = {
# The key of the map is the subnet ID to create the mount target on
"subnet-02cd47a492abcdef0" = { security_group_ids = ["sg-00ce17020babcdef0"] } # us-east-1a
"subnet-0f44f4247babcdef0" = { security_group_ids = ["sg-00ce17020babcdef0"] } # us-east-1b
}
# Configures multiple replications
replications = {
# The key of the map is the destination region
"us-east-2" = {} # replicates to us-east-2
"us-west-2" = { availability_zone = "us-west-2a" } # replicates to us-west-2 in one zone storage
}
}-
(string)
name[since v1.0.0]The name of the EFS file system. All associated resources' names will also be prefixed by this value
-
(map(object))
access_points = {}[since v1.0.0]Configures access points. See example
-
(map(string))
additional_tags = {}[since v1.0.0]Additional tags for the access point
-
(object)
posix_user = null[since v1.0.0]Configures the full POSIX identity on the access point that is used for all file operations by NFS clients
-
(number)
group_id[since v1.0.0]POSIX group ID used for all file system operations using this access point. valid value:
0 - 4294967295 -
(number)
user_id[since v1.0.0]POSIX user ID used for all file system operations using this access point. valid value:
0 - 4294967295 -
(list(number))
secondary_group_ids = null[since v1.0.0]Secondary POSIX group IDs used for all file system operations using this access point.
-
-
(object)
root_directory_creation_permissions = null[since v1.0.0]Configures the permissions EFS use to create the specified root directory if the directory does not already exist.
-
(string)
access_point_permissions[since v1.0.0]POSIX permissions to apply to the root directory path
-
(number)
owner_group_id[since v1.0.0]Owner group ID for the access point's root directory, if the directory does not already exist. valid value:
0 - 4294967295 -
(number)
owner_user_id[since v1.0.0]Owner user ID for the access point's root directory, if the directory does not already exist. valid value:
0 - 4294967295
-
-
(string)
root_directory_path = "/"[since v1.0.0]Path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories.
root_directory_creation_permissionsmust be specified if the root path does not exist.
-
-
(map(string))
additional_tags = {}[since v1.0.0]Additional tags for the EFS file system
-
(map(string))
additional_tags_all = {}[since v1.0.0]Additional tags for all resources deployed with this module
-
(string)
availability_zone = null[since v1.0.0]The AWS Availability Zone in which to create the file system. Specifying this value will result in an EFS using One Zone storage class.
-
(bool)
enable_automatic_backup = true[since v1.0.0]Enables EFS automatic backup
-
(object)
encryption = { enabled = true }[since v1.0.0]Configures encryption at rest.
-
(bool)
enabled = true[since v1.0.0]Whether encryption at rest is enabled
-
(string)
kms_key_id = null[since v1.0.0]The Key ID or ARN of the KMS key that should be used to encrypt the file system. If omitted, the default KMS key for EFS
/aws/elasticfilesystemwill be used
-
-
(string)
file_system_policy = null[since v1.0.0]Specify the JSON formatted file system policy for the EFS file system
-
(object)
lifecycle_policy = null[since v1.0.0]Configures lifecycle policy.
-
(string)
transition_to_infrequent_access = null[since v1.0.0]Indicates how long it takes to transition files to the 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","AFTER_365_DAYS" -
(string)
transition_to_primary_storage_class = null[since v1.0.0]Transitions a file from infequent access storage back to primary storage. Valid values:
"AFTER_1_ACCESS"
-
-
(map(object))
mount_targets = {}[since v1.0.0]Configures mount targets. See example
-
(list(string))
security_group_ids[since v1.0.0]A list of up to 5 VPC security group IDs in effect for the mount target
-
(string)
ip_address = null[since v1.0.0]The address (within the address range of the specified subnet) at which the file system may be mounted via the mount target.
-
-
(string)
performance_mode = "generalPurpose"[since v1.0.0]Specify the performance mode for the file system. Valid values:
"generalPurpose","maxIO"."maxIO"is only applicable tothroughput_modewith"provisioned"or"bursting" -
(number)
provisioned_throughput = null[since v1.0.0]Specify the throughput in MiB/s, that you want to provision for the file system. Only applicable with
throughput_mode = "provisioned" -
(map(object))
replications = {}[since v1.0.0]Configures replications. See example
-
(string)
availability_zone = null[since v1.0.0]The availability zone in which the replica should be created. If specified, the replica will be created with One Zone storage. If omitted, regional storage will be used.
-
(string)
kms_key_id = null[since v1.0.0]The Key ID or ARN of the KMS key that should be used to encrypt the replica file system. If omitted, the default KMS key for EFS
/aws/elasticfilesystemwill be used.
-
-
(string)
throughput_mode = "elastic"[since v1.0.0]Specify the Throughput mode for the file system. Valid values:
"bursting","provisioned", or"elastic"
-
(string)
efs_arn[since v1.0.0]The ARN of the EFS file system
-
(string)
efs_availability_zone_id[since v1.0.0]The identifier of the Availability Zone in which the file system's One Zone storage classes exist
-
(string)
efs_id[since v1.0.0]The ID that identifies the file system
-
(string)
efs_dns_name[since v1.0.0]The DNS name for the filesystem
-
(number)
efs_size_in_bytes[since v1.0.0]The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time
-
(object)
efs_mount_targets[since v1.0.0]Attributes of all mount targets for the file system
-
(string)
availability_zone_id[since v1.0.0]The unique and consistent identifier of the Availability Zone (AZ) that the mount target resides in
-
(string)
availability_zone_name[since v1.0.0]The name of the Availability Zone (AZ) that the mount target resides in
-
(string)
id[since v1.0.0]The ID of the mount target
-
(string)
mount_target_dns_name[since v1.0.0]The DNS name for the given subnet/AZ
-
(string)
network_interface_id[since v1.0.0]The ID of the network interface that Amazon EFS created when it created the mount target
-
-
(object)
efs_replications[since v1.0.0]Attributes of all replications for the file system
-
(string)
destination_file_system_id[since v1.0.0]The file system ID of the replica
-
(string)
replication_status[since v1.0.0]The status of the replication
-
Transition to archive is not available as of provider Version 5.29.0.