Skip to content
v2.276.0

AccessPointOptions Struct ​

Options to create an AccessPoint.

Example ​

ts
fileSystem.addAccessPoint('MyAccessPoint', {
  // create a unique access point via an optional client token
  clientToken: 'client-token',
});
python
file_system.add_access_point("MyAccessPoint",
    # create a unique access point via an optional client token
    client_token="client-token"
)
java
fileSystem.addAccessPoint("MyAccessPoint", AccessPointOptions.builder()
        // create a unique access point via an optional client token
        .clientToken("client-token")
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
fileSystem.AddAccessPoint("MyAccessPoint", new AccessPointOptions {
    // create a unique access point via an optional client token
    ClientToken = "client-token"
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
fileSystem.AddAccessPoint(jsii.String("MyAccessPoint"), &AccessPointOptions{
	// create a unique access point via an optional client token
	ClientToken: jsii.String("client-token"),
})

Properties ​

clientTokenoptionalstringclient_tokenoptionalstrclientTokenoptionalStringClientTokenoptionalstringClientTokenoptional*string#
The opaque string specified in the request to ensure idempotent creation.

Default: No client token

createAcloptionalAclcreate_acloptionalAclcreateAcloptionalAclCreateAcloptionalAclCreateAcloptionalAcl#
Specifies the POSIX IDs and permissions to apply when creating the access point's root directory.

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

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.

pathoptionalstringpathoptionalstrpathoptionalStringPathoptionalstringPathoptional*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.
posixUseroptionalPosixUserposix_useroptionalPosixUserposixUseroptionalPosixUserPosixUseroptionalPosixUserPosixUseroptionalPosixUser#
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.

Default: user identity not enforced

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