FileSystemProps Struct
Properties of EFS FileSystem.
Example
import * as iam from 'aws-cdk-lib/aws-iam';
const role = new iam.Role(this, 'ClientRole', {
assumedBy: new iam.AnyPrincipal(),
});
const fileSystem = new efs.FileSystem(this, 'MyEfsFileSystem', {
vpc: new ec2.Vpc(this, 'VPC'),
allowAnonymousAccess: true,
});
fileSystem.grantRead(role);
Properties
allowAnonymousAccessoptionalbooleanallow_anonymous_accessoptionalboolallowAnonymousAccessoptionalBooleanAllowAnonymousAccessoptionalboolAllowAnonymousAccessoptional*bool#Default: false when using grantRead, grantWrite, grantRootAccess or set @aws-cdk/aws-efs:denyAnonymousAccess feature flag, otherwise true
enableAutomaticBackupsoptionalbooleanenable_automatic_backupsoptionalboolenableAutomaticBackupsoptionalBooleanEnableAutomaticBackupsoptionalboolEnableAutomaticBackupsoptional*bool= false#encryptedoptionalbooleanencryptedoptionalboolencryptedoptionalBooleanEncryptedoptionalboolEncryptedoptional*bool#Default: If your application has the '@aws-cdk/aws-efs:defaultEncryptionAtRest' feature flag set, the default is true, otherwise, the default is false.
fileSystemNameoptionalstringfile_system_nameoptionalstrfileSystemNameoptionalStringFileSystemNameoptionalstringFileSystemNameoptional*string#Default: CDK generated name
fileSystemPolicyoptionalPolicyDocumentfile_system_policyoptionalPolicyDocumentfileSystemPolicyoptionalPolicyDocumentFileSystemPolicyoptionalPolicyDocumentFileSystemPolicyoptionalPolicyDocument= none#kmsKeyoptionalIKeyRefkms_keyoptionalIKeyRefkmsKeyoptionalIKeyRefKmsKeyoptionalIKeyRefKmsKeyoptionalIKeyRef#Default: if 'encrypted' is true, the default key for EFS (/aws/elasticfilesystem) is used
This is required to encrypt the data at rest if
lifecyclePolicyoptionalLifecyclePolicylifecycle_policyoptionalLifecyclePolicylifecyclePolicyoptionalLifecyclePolicyLifecyclePolicyoptionalLifecyclePolicyLifecyclePolicyoptionalLifecyclePolicy#Default: None. EFS will not transition files to the IA storage class.
oneZoneoptionalbooleanone_zoneoptionalbooloneZoneoptionalBooleanOneZoneoptionalboolOneZoneoptional*bool= false#If enabled, performanceMode must be set to GENERAL_PURPOSE and vpcSubnets cannot be set.
outOfInfrequentAccessPolicyoptionalOutOfInfrequentAccessPolicyout_of_infrequent_access_policyoptionalOutOfInfrequentAccessPolicyoutOfInfrequentAccessPolicyoptionalOutOfInfrequentAccessPolicyOutOfInfrequentAccessPolicyoptionalOutOfInfrequentAccessPolicyOutOfInfrequentAccessPolicyoptionalOutOfInfrequentAccessPolicy#Default: None. EFS will not transition files from IA storage to primary storage.
performanceModeoptionalPerformanceModeperformance_modeoptionalPerformanceModeperformanceModeoptionalPerformanceModePerformanceModeoptionalPerformanceModePerformanceModeoptionalPerformanceMode= PerformanceMode.GENERAL_PURPOSE#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.
provisionedThroughputPerSecondoptionalSizeprovisioned_throughput_per_secondoptionalSizeprovisionedThroughputPerSecondoptionalSizeProvisionedThroughputPerSecondoptionalSizeProvisionedThroughputPerSecondoptionalSize#Default: none, errors out
This is a required property if the throughput mode is set to PROVISIONED. Must be at least 1MiB/s.
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.RETAIN#replicationConfigurationoptionalReplicationConfigurationreplication_configurationoptionalReplicationConfigurationreplicationConfigurationoptionalReplicationConfigurationReplicationConfigurationoptionalReplicationConfigurationReplicationConfigurationoptionalReplicationConfiguration#Default: no replication
replicationOverwriteProtectionoptionalReplicationOverwriteProtectionreplication_overwrite_protectionoptionalReplicationOverwriteProtectionreplicationOverwriteProtectionoptionalReplicationOverwriteProtectionReplicationOverwriteProtectionoptionalReplicationOverwriteProtectionReplicationOverwriteProtectionoptionalReplicationOverwriteProtection#Default: ReplicationOverwriteProtection.ENABLED
Set false if you want to create a read-only filesystem for use as a replication destination.
securityGroupoptionalISecurityGroupsecurity_groupoptionalISecurityGroupsecurityGroupoptionalISecurityGroupSecurityGroupoptionalISecurityGroupSecurityGroupoptionalISecurityGroup#Default: creates new security group which allows all outbound traffic
throughputModeoptionalThroughputModethroughput_modeoptionalThroughputModethroughputModeoptionalThroughputModeThroughputModeoptionalThroughputModeThroughputModeoptionalThroughputMode= ThroughputMode.BURSTING#transitionToArchivePolicyoptionalLifecyclePolicytransition_to_archive_policyoptionalLifecyclePolicytransitionToArchivePolicyoptionalLifecyclePolicyTransitionToArchivePolicyoptionalLifecyclePolicyTransitionToArchivePolicyoptionalLifecyclePolicy#Default: None. EFS will not transition files to Archive storage class.
Metadata operations such as listing the contents of a directory don't count as file access events.
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection#Default: the Vpc default strategy if not specified