Skip to content
v2.277.0

AccessPointProps Struct ​

Properties for the AccessPoint.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_efs as efs } from 'aws-cdk-lib';
import { aws_efs as interfaces_efs } from 'aws-cdk-lib/interfaces';

declare const fileSystemRef: interfaces_efs.IFileSystemRef;
const accessPointProps: efs.AccessPointProps = {
  fileSystem: fileSystemRef,

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

    // the properties below are optional
    secondaryGids: ['secondaryGids'],
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_efs as efs
from aws_cdk.interfaces import aws_efs as interfaces_efs

# file_system_ref: interfaces_efs.IFileSystemRef

access_point_props = efs.AccessPointProps(
    file_system=file_system_ref,

    # the properties below are optional
    client_token="clientToken",
    create_acl=efs.Acl(
        owner_gid="ownerGid",
        owner_uid="ownerUid",
        permissions="permissions"
    ),
    path="path",
    posix_user=efs.PosixUser(
        gid="gid",
        uid="uid",

        # the properties below are optional
        secondary_gids=["secondaryGids"]
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.efs.*;
import software.amazon.awscdk.interfaces.efs.*;

IFileSystemRef fileSystemRef;

AccessPointProps accessPointProps = AccessPointProps.builder()
        .fileSystem(fileSystemRef)

        // the properties below are optional
        .clientToken("clientToken")
        .createAcl(Acl.builder()
                .ownerGid("ownerGid")
                .ownerUid("ownerUid")
                .permissions("permissions")
                .build())
        .path("path")
        .posixUser(PosixUser.builder()
                .gid("gid")
                .uid("uid")

                // the properties below are optional
                .secondaryGids(List.of("secondaryGids"))
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EFS;
using Amazon.CDK.Interfaces.EFS;

IFileSystemRef fileSystemRef;

var accessPointProps = new AccessPointProps {
    FileSystem = fileSystemRef,

    // the properties below are optional
    ClientToken = "clientToken",
    CreateAcl = new Acl {
        OwnerGid = "ownerGid",
        OwnerUid = "ownerUid",
        Permissions = "permissions"
    },
    Path = "path",
    PosixUser = new PosixUser {
        Gid = "gid",
        Uid = "uid",

        // the properties below are optional
        SecondaryGids = new [] { "secondaryGids" }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var fileSystemRef IFileSystemRef

accessPointProps := &AccessPointProps{
	FileSystem: fileSystemRef,

	// the properties below are optional
	ClientToken: jsii.String("clientToken"),
	CreateAcl: &Acl{
		OwnerGid: jsii.String("ownerGid"),
		OwnerUid: jsii.String("ownerUid"),
		Permissions: jsii.String("permissions"),
	},
	Path: jsii.String("path"),
	PosixUser: &PosixUser{
		Gid: jsii.String("gid"),
		Uid: jsii.String("uid"),

		// the properties below are optional
		SecondaryGids: []*string{
			jsii.String("secondaryGids"),
		},
	},
}

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.

fileSystemIFileSystemReffile_systemIFileSystemReffileSystemIFileSystemRefFileSystemIFileSystemRefFileSystemIFileSystemRefrequired#
The efs filesystem.
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.