AWS EFS JSON Schema
This JSON Schema defines for AWS EFS resources.
Properties
Property |
Type |
Required |
Description |
flavor |
string |
Yes |
Possible values are: default . |
kind |
string |
Yes |
Possible values are: aws_efs . |
version |
string |
Yes |
Possible values are: 0.1 , latest . |
advanced |
object |
No |
|
out |
object |
No |
The output for your aws efs module, this can be generated or provided |
advanced
Properties
Property |
Type |
Required |
Description |
aws_efs |
object |
No |
The advanced section of all the aws efs module |
aws_efs
The advanced section of all the aws efs module
Properties
Property |
Type |
Required |
Description |
availability_zone_name |
string |
No |
The AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes |
creation_token |
string |
No |
A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by Terraform |
encrypted |
boolean |
No |
If true, the disk will be encrypted |
kms_key_id |
string |
No |
The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true |
lifecycle_policy |
object |
No |
A file system lifecycle policy object |
performance_mode |
string |
No |
The file system performance mode Possible values are: generalPurpose , maxIO . |
provisioned_throughput_in_mibps |
integer |
No |
The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with throughput_mode set to provisioned |
tags |
object |
No |
A map of tags to assign to the file system |
throughput_mode |
string |
No |
Throughput mode for the file system Possible values are: bursting , provisioned . |
lifecycle_policy
A file system lifecycle policy object
Properties
Property |
Type |
Required |
Description |
transition_to_ia |
string |
No |
Indicates how long it takes to transition files to the IA storage class Possible values are: AFTER_7_DAYS , AFTER_14_DAYS , AFTER_30_DAYS , AFTER_60_DAYS , AFTER_90_DAYS . |
transition_to_primary_storage_class |
string |
No |
Describes the policy used to transition a file from infequent access storage to primary storage Possible values are: AFTER_1_ACCESS . |
out
The output for your aws efs module, this can be generated or provided
Properties
Property |
Type |
Required |
Description |
attributes |
object |
No |
The advanced section of all the aws efs module |
attributes
The advanced section of all the aws efs module
Properties
Property |
Type |
Required |
Description |
file_system_id |
string |
No |
File System ID |
storage_class_name |
string |
No |
Name of the Storage Class |