AWS CDK Reference

Appearance

v2.273.0

IFileSystem Interface ​

Represents an Amazon EFS file system.

Source
aws-efs/lib/efs-file-system.ts
Type last changed
v2.234.0 · 8 Jan 2026

Properties ​

connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsrequired#
The network connections associated with this resource.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#
The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

fileSystemArnstringfile_system_arnstrfileSystemArnStringFileSystemArnstringFileSystemArn*stringrequired#
The ARN of the file system.
fileSystemIdstringfile_system_idstrfileSystemIdStringFileSystemIdstringFileSystemId*stringrequired#
The ID of the file system, assigned by Amazon EFS.
fileSystemRefFileSystemReferencefile_system_refFileSystemReferencefileSystemRefFileSystemReferenceFileSystemRefFileSystemReferenceFileSystemRefFileSystemReferencerequired#
A reference to a FileSystem resource.
mountTargetsAvailableIDependablemount_targets_availableIDependablemountTargetsAvailableIDependableMountTargetsAvailableIDependableMountTargetsAvailableIDependablerequired#
Dependable that can be depended upon to ensure the mount targets of the filesystem are ready.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.

Methods ​

addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResultdef add_to_resource_policy(self, statement: PolicyStatement) -> AddToResourcePolicyResultpublic AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)public AddToResourcePolicyResult AddToResourcePolicy(PolicyStatement statement)func AddToResourcePolicy(Statement PolicyStatement) AddToResourcePolicyResult#
Add a statement to the resource's resource policy.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#
Grant the actions defined in actions to the given grantee on this File System resource.
grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#
Grant read permissions for this file system to an IAM principal.
1 parameter

Parameters

  • granteegranteegranteegranteeGrantee — The principal to grant read to.
grantReadWrite(grantee: IGrantable): Grantdef grant_read_write(self, grantee: IGrantable) -> Grantpublic Grant grantReadWrite(IGrantable grantee)public Grant GrantReadWrite(IGrantable grantee)func GrantReadWrite(Grantee IGrantable) Grant#
Grant read and write permissions for this file system to an IAM principal.
1 parameter

Parameters

  • granteegranteegranteegranteeGrantee — The principal to grant read and write to.
grantRootAccess(grantee: IGrantable): Grantdef grant_root_access(self, grantee: IGrantable) -> Grantpublic Grant grantRootAccess(IGrantable grantee)public Grant GrantRootAccess(IGrantable grantee)func GrantRootAccess(Grantee IGrantable) Grant#
As root user, grant read and write permissions for this file system to an IAM principal.
1 parameter

Parameters

  • granteegranteegranteegranteeGrantee — The principal to grant root access to.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining