Class AccessPointOptions

Options to create an AccessPoint.

Inheritance

object

AccessPointOptions

Implements

IAccessPointOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EFS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class AccessPointOptions : IAccessPointOptions

Syntax (vb)

Public Class AccessPointOptions Implements IAccessPointOptions

Remarks

ExampleMetadata: fixture=with-filesystem-instance infused

Examples

fileSystem.AddAccessPoint("MyAccessPoint", new AccessPointOptions {
                // create a unique access point via an optional client token
                ClientToken = "client-token"
            });

Synopsis

Constructors

AccessPointOptions()

Options to create an AccessPoint.

Properties

ClientToken	The opaque string specified in the request to ensure idempotent creation.
CreateAcl	Specifies the POSIX IDs and permissions to apply when creating the access point's root directory.
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.
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.

Constructors

AccessPointOptions()

Options to create an AccessPoint.

public AccessPointOptions()

Remarks

ExampleMetadata: fixture=with-filesystem-instance infused

Examples

fileSystem.AddAccessPoint("MyAccessPoint", new AccessPointOptions {
                // create a unique access point via an optional client token
                ClientToken = "client-token"
            });

Properties

ClientToken

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

public string? ClientToken { get; set; }

Property Value

string

Remarks

Default: - No client token

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

CreateAcl

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

public IAcl? CreateAcl { get; set; }

Property Value

IAcl

Remarks

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.

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.

public string? Path { get; set; }

Property Value

string

Remarks

Default: '/'

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.

public IPosixUser? PosixUser { get; set; }

Property Value

IPosixUser

Remarks

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

Default: - user identity not enforced

See: - Enforcing a User Identity Using an Access Point

Implements

IAccessPointOptions