interface CfnAccessPointProps

Language	Type name
.NET	Amazon.CDK.AWS.EFS.CfnAccessPointProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsefs#CfnAccessPointProps
Java	software.amazon.awscdk.services.efs.CfnAccessPointProps
Python	aws_cdk.aws_efs.CfnAccessPointProps
TypeScript	aws-cdk-lib » aws_efs » CfnAccessPointProps

Properties for defining a CfnAccessPoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html

Example

// 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';
const cfnAccessPointProps: efs.CfnAccessPointProps = {
  fileSystemId: 'fileSystemId',

  // the properties below are optional
  accessPointTags: [{
    key: 'key',
    value: 'value',
  }],
  clientToken: 'clientToken',
  posixUser: {
    gid: 'gid',
    uid: 'uid',

    // the properties below are optional
    secondaryGids: ['secondaryGids'],
  },
  rootDirectory: {
    creationInfo: {
      ownerGid: 'ownerGid',
      ownerUid: 'ownerUid',
      permissions: 'permissions',
    },
    path: 'path',
  },
};

Properties

Name	Type	Description
fileSystemId	string	The ID of the EFS file system that the access point applies to.
accessPointTags?	AccessPointTagProperty[]	An array of key-value pairs to apply to this resource.
clientToken?	string	The opaque string specified in the request to ensure idempotent creation.
posixUser?	IResolvable | PosixUserProperty	The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
rootDirectory?	IResolvable | RootDirectoryProperty	The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.

---

fileSystemId

Type: string

The ID of the EFS file system that the access point applies to.

Accepts only the ID format for input when specifying a file system, for example fs-0123456789abcedf2 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-filesystemid

---

accessPointTags?

Type: AccessPointTagProperty[] (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-accesspointtags

---

clientToken?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-clienttoken

---

posixUser?

Type: IResolvable | PosixUserProperty (optional)

The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-posixuser

---

rootDirectory?

Type: IResolvable | RootDirectoryProperty (optional)

The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-rootdirectory