Package software.amazon.awscdk.services.efs

Interface IFileSystem

All Superinterfaces:

IConnectable, software.constructs.IConstruct, software.constructs.IDependable, IResource, IResourceWithPolicy, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IFileSystem.Jsii$Default

All Known Implementing Classes:

FileSystem, IFileSystem.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:42.987Z")
@Stability(Stable)
public interface IFileSystem
extends software.amazon.jsii.JsiiSerializable, IConnectable, IResourceWithPolicy

Represents an Amazon EFS file system.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IFileSystem.Jsii$Default	Internal default implementation for IFileSystem.
static final class	IFileSystem.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getFileSystemArn()	The ARN of the file system.
String	getFileSystemId()	The ID of the file system, assigned by Amazon EFS.
software.constructs.IDependable	getMountTargetsAvailable()	Dependable that can be depended upon to ensure the mount targets of the filesystem are ready.
Grant	grant(IGrantable grantee, @NotNull String... actions)	Grant the actions defined in actions to the given grantee on this File System resource.
Grant	grantRead(IGrantable grantee)	Grant read permissions for this file system to an IAM principal.
Grant	grantReadWrite(IGrantable grantee)	Grant read and write permissions for this file system to an IAM principal.
Grant	grantRootAccess(IGrantable grantee)	As root user, grant read and write permissions for this file system to an IAM principal.

Methods inherited from interface software.amazon.awscdk.services.ec2.IConnectable

getConnections

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.services.iam.IResourceWithPolicy

addToResourcePolicy

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFileSystemArn

@Stability(Stable)
@NotNull
String getFileSystemArn()

The ARN of the file system.

getFileSystemId

@Stability(Stable)
@NotNull
String getFileSystemId()

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

getMountTargetsAvailable

@Stability(Stable)
@NotNull
software.constructs.IDependable getMountTargetsAvailable()

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

grant

@Stability(Stable)
@NotNull
Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 @NotNull String... actions)

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

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantRead

@Stability(Stable)
@NotNull
Grant grantRead(@NotNull
 IGrantable grantee)

Grant read permissions for this file system to an IAM principal.

Parameters:

grantee - The principal to grant read to. This parameter is required.

grantReadWrite

@Stability(Stable)
@NotNull
Grant grantReadWrite(@NotNull
 IGrantable grantee)

Grant read and write permissions for this file system to an IAM principal.

Parameters:

grantee - The principal to grant read and write to. This parameter is required.

grantRootAccess

@Stability(Stable)
@NotNull
Grant grantRootAccess(@NotNull
 IGrantable grantee)

As root user, grant read and write permissions for this file system to an IAM principal.

Parameters:

grantee - The principal to grant root access to. This parameter is required.