Package software.amazon.awscdk.services.efs

Class FileSystem

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.efs.FileSystem
All Implemented Interfaces:
IResource, IConnectable, IFileSystem, IResourceWithPolicy, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:39.452Z") @Stability(Stable) public class FileSystem extends Resource implements IFileSystem
The Elastic File System implementation of IFileSystem.

It creates a new, empty file system in Amazon Elastic File System (Amazon EFS). It also creates mount target (AWS::EFS::MountTarget) implicitly to mount the EFS file system on an Amazon Elastic Compute Cloud (Amazon EC2) instance or another resource.

Example: 

 import software.amazon.awscdk.services.iam.*;
 Role role = Role.Builder.create(this, "ClientRole")
         .assumedBy(new AnyPrincipal())
         .build();
 FileSystem fileSystem = FileSystem.Builder.create(this, "MyEfsFileSystem")
         .vpc(new Vpc(this, "VPC"))
         .allowAnonymousAccess(true)
         .build();
 fileSystem.grantRead(role);

See Also:

  • Field Details

    • DEFAULT_PORT

      @Stability(Stable) public static final Number DEFAULT_PORT
      The default port File System listens on.

    • PROPERTY_INJECTION_ID

      @Stability(Stable) public static final String PROPERTY_INJECTION_ID
      Uniquely identifies this class.

  • Constructor Details

    • FileSystem

      protected FileSystem(software.amazon.jsii.JsiiObjectRef objRef)

    • FileSystem

      protected FileSystem(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • FileSystem

      @Stability(Stable) public FileSystem(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull FileSystemProps props)
      Constructor for creating a new EFS FileSystem.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromFileSystemAttributes

      @Stability(Stable) @NotNull public static IFileSystem fromFileSystemAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull FileSystemAttributes attrs)
      Import an existing File System from the given properties.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      attrs - This parameter is required.

    • addAccessPoint

      @Stability(Stable) @NotNull public AccessPoint addAccessPoint(@NotNull String id, @Nullable AccessPointOptions accessPointOptions)
      create access point from this filesystem.

      Parameters:
      id - This parameter is required.
      accessPointOptions -

    • addAccessPoint

      @Stability(Stable) @NotNull public AccessPoint addAccessPoint(@NotNull String id)
      create access point from this filesystem.

      Parameters:
      id - This parameter is required.

    • addToResourcePolicy

      @Stability(Stable) @NotNull public AddToResourcePolicyResult addToResourcePolicy(@NotNull PolicyStatement statement)
      Adds a statement to the resource policy associated with this file system.

      A resource policy will be automatically created upon the first call to addToResourcePolicy.

      Note that this does not work with imported file systems.

      Specified by:
      addToResourcePolicy in interface IResourceWithPolicy
      Parameters:
      statement - The policy statement to add. This parameter is required.

    • grant

      @Stability(Stable) @NotNull public Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      Grant the actions defined in actions to the given grantee on this File System resource.

      Specified by:
      grant in interface IFileSystem
      Parameters:
      grantee - Principal to grant right to. This parameter is required.
      actions - The actions to grant. This parameter is required.

    • grantRead

      @Stability(Stable) @NotNull public Grant grantRead(@NotNull IGrantable grantee)
      Grant read permissions for this file system to an IAM principal.

      Specified by:
      grantRead in interface IFileSystem
      Parameters:
      grantee - The principal to grant read to. This parameter is required.

    • grantReadWrite

      @Stability(Stable) @NotNull public Grant grantReadWrite(@NotNull IGrantable grantee)
      Grant read and write permissions for this file system to an IAM principal.

      Specified by:
      grantReadWrite in interface IFileSystem
      Parameters:
      grantee - The principal to grant read and write to. This parameter is required.

    • grantRootAccess

      @Stability(Stable) @NotNull public Grant grantRootAccess(@NotNull IGrantable grantee)
      As root user, grant read and write permissions for this file system to an IAM principal.

      Specified by:
      grantRootAccess in interface IFileSystem
      Parameters:
      grantee - The principal to grant root access to. This parameter is required.

    • getConnections

      @Stability(Stable) @NotNull public Connections getConnections()
      The security groups/rules used to allow network connections to the file system.
      Specified by:
      getConnections in interface IConnectable

    • getFileSystemArn

      @Stability(Stable) @NotNull public String getFileSystemArn()
      The ARN of the file system.
      Specified by:
      getFileSystemArn in interface IFileSystem

    • getFileSystemId

      @Stability(Stable) @NotNull public String getFileSystemId()
      The ID of the file system, assigned by Amazon EFS.
      Specified by:
      getFileSystemId in interface IFileSystem

    • getMountTargetsAvailable

      @Stability(Stable) @NotNull public software.constructs.IDependable getMountTargetsAvailable()
      Dependable that can be depended upon to ensure the mount targets of the filesystem are ready.
      Specified by:
      getMountTargetsAvailable in interface IFileSystem