interface IFileSystem

Language	Type name
.NET	Amazon.CDK.AWS.EFS.IFileSystem
Java	software.amazon.awscdk.services.efs.IFileSystem
Python	aws_cdk.aws_efs.IFileSystem
TypeScript (source)	@aws-cdk/aws-efs » IFileSystem

Implemented by FileSystem

Obtainable from FileSystem.fromFileSystemAttributes()

Represents an Amazon EFS file system.

Properties

Name	Type	Description
connections	Connections	The network connections associated with this resource.
env	ResourceEnvironment	The environment this resource belongs to.
fileSystemArn	string	The ARN of the file system.
fileSystemId	string	The ID of the file system, assigned by Amazon EFS.
mountTargetsAvailable	IDependable	Dependable that can be depended upon to ensure the mount targets of the filesystem are ready.
node	ConstructNode	The construct tree node for this construct.
stack	Stack	The stack in which this resource is defined.

---

connections

Type: Connections

The network connections associated with this resource.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

fileSystemArn

Type: string

The ARN of the file system.

---

fileSystemId

Type: string

The ID of the file system, assigned by Amazon EFS.

---

mountTargetsAvailable

Type: IDependable

Dependable that can be depended upon to ensure the mount targets of the filesystem are ready.

---

node

Type: ConstructNode

The construct tree node for this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grant(grantee, ...actions)	Grant the actions defined in actions to the given grantee on this File System resource.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

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, ...actions)

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

• grantee IGrantable
• actions string

Returns

• Grant

Grant the actions defined in actions to the given grantee on this File System resource.