interface AccessPointProps

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

Properties for the AccessPoint.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as efs from '@aws-cdk/aws-efs';

declare const fileSystem: efs.FileSystem;
const accessPointProps: efs.AccessPointProps = {
  fileSystem: fileSystem,

  // the properties below are optional
  createAcl: {
    ownerGid: 'ownerGid',
    ownerUid: 'ownerUid',
    permissions: 'permissions',
  },
  path: 'path',
  posixUser: {
    gid: 'gid',
    uid: 'uid',

    // the properties below are optional
    secondaryGids: ['secondaryGids'],
  },
};

Properties

Name	Type	Description
fileSystem	`IFileSystem`	The efs filesystem.
createAcl?	`Acl`	Specifies the POSIX IDs and permissions to apply when creating the access point's root directory.
path?	`string`	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.
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.

fileSystem

Type: IFileSystem

The efs filesystem.

createAcl?

Type: Acl (optional, default: None. The directory specified by path must exist.)

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.

path?

Type: string (optional, default: '/')

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.

posixUser?

Type: PosixUser (optional, default: user identity not enforced)

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.