FileSystemProps¶
-
class
aws_cdk.aws_efs.
FileSystemProps
(*, vpc, enable_automatic_backups=None, encrypted=None, file_system_name=None, kms_key=None, lifecycle_policy=None, performance_mode=None, provisioned_throughput_per_second=None, removal_policy=None, security_group=None, throughput_mode=None, vpc_subnets=None)¶ Bases:
object
(experimental) Properties of EFS FileSystem.
- Parameters
vpc (
IVpc
) – (experimental) VPC to launch the file system in.enable_automatic_backups (
Optional
[bool
]) – (experimental) Whether to enable automatic backups for the file system. Default: falseencrypted (
Optional
[bool
]) – (experimental) Defines if the data at rest in the file system is encrypted or not. Default: falsefile_system_name (
Optional
[str
]) – (experimental) The file system’s name. Default: - CDK generated namekms_key (
Optional
[IKey
]) – (experimental) The KMS key used for encryption. This is required to encrypt the data at rest if @encrypted is set to true. Default: - if ‘encrypted’ is true, the default key for EFS (/aws/elasticfilesystem) is usedlifecycle_policy (
Optional
[LifecyclePolicy
]) – (experimental) A policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class. Default: - None. EFS will not transition files to the IA storage class.performance_mode (
Optional
[PerformanceMode
]) – (experimental) The performance mode that the file system will operate under. An Amazon EFS file system’s performance mode can’t be changed after the file system has been created. Updating this property will replace the file system. Default: PerformanceMode.GENERAL_PURPOSEprovisioned_throughput_per_second (
Optional
[Size
]) – (experimental) Provisioned throughput for the file system. This is a required property if the throughput mode is set to PROVISIONED. Must be at least 1MiB/s. Default: - none, errors outremoval_policy (
Optional
[RemovalPolicy
]) – (experimental) The removal policy to apply to the file system. Default: RemovalPolicy.RETAINsecurity_group (
Optional
[ISecurityGroup
]) – (experimental) Security Group to assign to this file system. Default: - creates new security group which allows all outbound trafficthroughput_mode (
Optional
[ThroughputMode
]) – (experimental) Enum to mention the throughput mode of the file system. Default: ThroughputMode.BURSTINGvpc_subnets (
Optional
[SubnetSelection
]) – (experimental) Which subnets to place the mount target in the VPC. Default: - the Vpc default strategy if not specified
- Stability
experimental
Attributes
-
enable_automatic_backups
¶ (experimental) Whether to enable automatic backups for the file system.
- Default
false
- Stability
experimental
- Return type
Optional
[bool
]
-
encrypted
¶ (experimental) Defines if the data at rest in the file system is encrypted or not.
- Default
false
- Stability
experimental
- Return type
Optional
[bool
]
-
file_system_name
¶ (experimental) The file system’s name.
- Default
CDK generated name
- Stability
experimental
- Return type
Optional
[str
]
-
kms_key
¶ (experimental) The KMS key used for encryption.
This is required to encrypt the data at rest if @encrypted is set to true.
- Default
if ‘encrypted’ is true, the default key for EFS (/aws/elasticfilesystem) is used
- Stability
experimental
- Return type
Optional
[IKey
]
-
lifecycle_policy
¶ (experimental) A policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.
- Default
None. EFS will not transition files to the IA storage class.
- Stability
experimental
- Return type
Optional
[LifecyclePolicy
]
-
performance_mode
¶ (experimental) The performance mode that the file system will operate under.
An Amazon EFS file system’s performance mode can’t be changed after the file system has been created. Updating this property will replace the file system.
- Default
PerformanceMode.GENERAL_PURPOSE
- Stability
experimental
- Return type
Optional
[PerformanceMode
]
-
provisioned_throughput_per_second
¶ (experimental) Provisioned throughput for the file system.
This is a required property if the throughput mode is set to PROVISIONED. Must be at least 1MiB/s.
- Default
none, errors out
- Stability
experimental
- Return type
Optional
[Size
]
-
removal_policy
¶ (experimental) The removal policy to apply to the file system.
- Default
RemovalPolicy.RETAIN
- Stability
experimental
- Return type
Optional
[RemovalPolicy
]
-
security_group
¶ (experimental) Security Group to assign to this file system.
- Default
creates new security group which allows all outbound traffic
- Stability
experimental
- Return type
Optional
[ISecurityGroup
]
-
throughput_mode
¶ (experimental) Enum to mention the throughput mode of the file system.
- Default
ThroughputMode.BURSTING
- Stability
experimental
- Return type
Optional
[ThroughputMode
]
-
vpc_subnets
¶ (experimental) Which subnets to place the mount target in the VPC.
- Default
the Vpc default strategy if not specified
- Stability
experimental
- Return type
Optional
[SubnetSelection
]