software.amazon.awscdk.services.efs

Class AccessPoint.Builder

java.lang.Object

software.amazon.awscdk.services.efs.AccessPoint.Builder

Enclosing class:

AccessPoint

public static final class AccessPoint.Builder
extends java.lang.Object

A fluent builder for AccessPoint.

Method Summary

Modifier and Type	Method and Description
AccessPoint	build()
static AccessPoint.Builder	create(software.constructs.Construct scope, java.lang.String id)
AccessPoint.Builder	createAcl(Acl createAcl) Specifies the POSIX IDs and permissions to apply when creating the access point's root directory.
AccessPoint.Builder	fileSystem(IFileSystem fileSystem) The efs filesystem.
AccessPoint.Builder	path(java.lang.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.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static AccessPoint.Builder create(software.constructs.Construct scope,
                                         java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of AccessPoint.Builder.

createAcl

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

public AccessPoint.Builder path(java.lang.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

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:

- [Enforcing a User Identity Using an Access Point](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html)

fileSystem

public AccessPoint.Builder fileSystem(IFileSystem fileSystem)

The efs filesystem.

Parameters:

fileSystem - The efs filesystem. This parameter is required.

Returns:

this

build

public AccessPoint build()