2.169.0

interface FileSystemProps

LanguageType name
.NETAmazon.CDK.AWS.EFS.FileSystemProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsefs#FileSystemProps
Javasoftware.amazon.awscdk.services.efs.FileSystemProps
Pythonaws_cdk.aws_efs.FileSystemProps
TypeScript (source)aws-cdk-lib » aws_efs » FileSystemProps

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

NameTypeDescription
vpcIVpcVPC to launch the file system in.
allowAnonymousAccess?booleanAllow access from anonymous client that doesn't use IAM authentication.
enableAutomaticBackups?booleanWhether to enable automatic backups for the file system.
encrypted?booleanDefines if the data at rest in the file system is encrypted or not.
fileSystemName?stringThe file system's name.
fileSystemPolicy?PolicyDocumentFile system policy is an IAM resource policy used to control NFS access to an EFS file system.
kmsKey?IKeyThe KMS key used for encryption.
lifecyclePolicy?LifecyclePolicyA policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.
oneZone?booleanWhether this is a One Zone file system.
outOfInfrequentAccessPolicy?OutOfInfrequentAccessPolicyA policy used by EFS lifecycle management to transition files from Infrequent Access (IA) storage class to primary storage class.
performanceMode?PerformanceModeThe performance mode that the file system will operate under.
provisionedThroughputPerSecond?SizeProvisioned throughput for the file system.
removalPolicy?RemovalPolicyThe removal policy to apply to the file system.
replicationConfiguration?ReplicationConfigurationReplication configuration for the file system.
replicationOverwriteProtection?ReplicationOverwriteProtectionWhether to enable the filesystem's replication overwrite protection or not.
securityGroup?ISecurityGroupSecurity Group to assign to this file system.
throughputMode?ThroughputModeEnum to mention the throughput mode of the file system.
transitionToArchivePolicy?LifecyclePolicyThe number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage.
vpcSubnets?SubnetSelectionWhich subnets to place the mount target in the VPC.

vpc

Type: IVpc

VPC to launch the file system in.

allowAnonymousAccess?

Type: boolean (optional, default: false when using grantRead, grantWrite, grantRootAccess or set @aws-cdk/aws-efs:denyAnonymousAccess feature flag, otherwise true)

Allow access from anonymous client that doesn't use IAM authentication.

enableAutomaticBackups?

Type: boolean (optional, default: false)

Whether to enable automatic backups for the file system.

encrypted?

Type: boolean (optional, default: If your application has the '@aws-cdk/aws-efs:defaultEncryptionAtRest' feature flag set, the default is true, otherwise, the default is false.)

Defines if the data at rest in the file system is encrypted or not.

fileSystemName?

Type: string (optional, default: CDK generated name)

The file system's name.

fileSystemPolicy?

Type: PolicyDocument (optional, default: none)

File system policy is an IAM resource policy used to control NFS access to an EFS file system.

kmsKey?

Type: IKey (optional, default: if 'encrypted' is true, the default key for EFS (/aws/elasticfilesystem) is used)

The KMS key used for encryption.

This is required to encrypt the data at rest if

lifecyclePolicy?

Type: LifecyclePolicy (optional, default: None. EFS will not transition files to the IA storage class.)

A policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.

oneZone?

Type: boolean (optional, default: false)

Whether this is a One Zone file system.

If enabled, performanceMode must be set to GENERAL_PURPOSE and vpcSubnets cannot be set.

outOfInfrequentAccessPolicy?

Type: OutOfInfrequentAccessPolicy (optional, default: None. EFS will not transition files from IA storage to primary storage.)

A policy used by EFS lifecycle management to transition files from Infrequent Access (IA) storage class to primary storage class.

performanceMode?

Type: PerformanceMode (optional, default: PerformanceMode.GENERAL_PURPOSE)

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.

provisionedThroughputPerSecond?

Type: Size (optional, default: none, errors out)

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.

removalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.RETAIN)

The removal policy to apply to the file system.

replicationConfiguration?

Type: ReplicationConfiguration (optional, default: no replication)

Replication configuration for the file system.

replicationOverwriteProtection?

Type: ReplicationOverwriteProtection (optional, default: ReplicationOverwriteProtection.ENABLED)

Whether to enable the filesystem's replication overwrite protection or not.

Set false if you want to create a read-only filesystem for use as a replication destination.

See also: https://docs.aws.amazon.com/efs/latest/ug/replication-use-cases.html#replicate-existing-destination

securityGroup?

Type: ISecurityGroup (optional, default: creates new security group which allows all outbound traffic)

Security Group to assign to this file system.

throughputMode?

Type: ThroughputMode (optional, default: ThroughputMode.BURSTING)

Enum to mention the throughput mode of the file system.

transitionToArchivePolicy?

Type: LifecyclePolicy (optional, default: None. EFS will not transition files to Archive storage class.)

The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage.

Metadata operations such as listing the contents of a directory don't count as file access events.

vpcSubnets?

Type: SubnetSelection (optional, default: the Vpc default strategy if not specified)

Which subnets to place the mount target in the VPC.

← PreviousNext →