Class CfnAccessPoint.RootDirectoryProperty

Specifies the directory on the Amazon EFS file system that the access point provides access to.

Inheritance

object

CfnAccessPoint.RootDirectoryProperty

Implements

CfnAccessPoint.IRootDirectoryProperty

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 CfnAccessPoint.RootDirectoryProperty : CfnAccessPoint.IRootDirectoryProperty

Syntax (vb)

Public Class CfnAccessPoint.RootDirectoryProperty Implements CfnAccessPoint.IRootDirectoryProperty

Remarks

The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's RootDirectory and its subdirectories.

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

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;

             var rootDirectoryProperty = new RootDirectoryProperty {
                 CreationInfo = new CreationInfoProperty {
                     OwnerGid = "ownerGid",
                     OwnerUid = "ownerUid",
                     Permissions = "permissions"
                 },
                 Path = "path"
             };

Synopsis

Constructors

RootDirectoryProperty()

Specifies the directory on the Amazon EFS file system that the access point provides access to.

Properties

CreationInfo	(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory .
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.

Constructors

RootDirectoryProperty()

Specifies the directory on the Amazon EFS file system that the access point provides access to.

public RootDirectoryProperty()

Remarks

The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's RootDirectory and its subdirectories.

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

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;

             var rootDirectoryProperty = new RootDirectoryProperty {
                 CreationInfo = new CreationInfoProperty {
                     OwnerGid = "ownerGid",
                     OwnerUid = "ownerUid",
                     Permissions = "permissions"
                 },
                 Path = "path"
             };

Properties

CreationInfo

(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory .

public object? CreationInfo { get; set; }

Property Value

object

Remarks

If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo , you must provide values for all properties.

If you do not provide <code>CreationInfo</code> and the specified <code>RootDirectory</code> > <code>Path</code> does not exist, attempts to mount the file system using the access point will fail.

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

Type union: either IResolvable or CfnAccessPoint.ICreationInfoProperty

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

A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo .

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

Implements

CfnAccessPoint.IRootDirectoryProperty