Class AccessPoint.Builder

java.lang.Object
software.amazon.awscdk.services.efs.AccessPoint.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<AccessPoint>
Enclosing class:
AccessPoint

@Stability(Stable) public static final class AccessPoint.Builder extends Object implements software.amazon.jsii.Builder<AccessPoint>
A fluent builder for AccessPoint.
  • Method Details

    • create

      @Stability(Stable) public static AccessPoint.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of AccessPoint.Builder.
    • createAcl

      @Stability(Stable) public AccessPoint.Builder createAcl(Acl createAcl)
      Specifies the POSIX IDs and permissions to apply when creating the access point's root directory.

      If the root directory specified by path does not exist, EFS creates the root directory and applies the permissions specified here. If the specified path does not exist, you must specify createAcl.

      Default: - None. The directory specified by `path` must exist.

      Parameters:
      createAcl - Specifies the POSIX IDs and permissions to apply when creating the access point's root directory. This parameter is required.
      Returns:
      this
    • path

      @Stability(Stable) public AccessPoint.Builder path(String path)
      Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system.

      Default: '/'

      Parameters:
      path - Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. This parameter is required.
      Returns:
      this
    • posixUser

      @Stability(Stable) public AccessPoint.Builder posixUser(PosixUser posixUser)
      The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.

      Specify this to enforce a user identity using an access point.

      Default: - user identity not enforced

      Parameters:
      posixUser - The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point. This parameter is required.
      Returns:
      this
      See Also:
    • fileSystem

      @Stability(Stable) public AccessPoint.Builder fileSystem(IFileSystem fileSystem)
      The efs filesystem.

      Parameters:
      fileSystem - The efs filesystem. This parameter is required.
      Returns:
      this
    • build

      @Stability(Stable) public AccessPoint build()
      Specified by:
      build in interface software.amazon.jsii.Builder<AccessPoint>
      Returns:
      a newly built instance of AccessPoint.