Class AccessPointProps

Properties for the AccessPoint.

Inheritance
System.Object
AccessPointProps
Namespace: Amazon.CDK.AWS.EFS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class AccessPointProps : Object, IAccessPointProps, IAccessPointOptions
Syntax (vb)
Public Class AccessPointProps
    Inherits Object
    Implements IAccessPointProps, IAccessPointOptions
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EFS;

FileSystem fileSystem;

var accessPointProps = new AccessPointProps {
    FileSystem = fileSystem,

    // 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" }
    }
};

Synopsis

Constructors

AccessPointProps()

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.
FileSystem

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

AccessPointProps()

public AccessPointProps()

Properties

ClientToken

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

public string ClientToken { get; set; }
Property Value

System.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.

FileSystem

The efs filesystem.

public IFileSystem FileSystem { get; set; }
Property Value

IFileSystem

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

System.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