software.amazon.awscdk.services.efs

Interface CfnAccessPoint.RootDirectoryProperty

All Known Implementing Classes:

CfnAccessPoint.RootDirectoryProperty.Jsii$Proxy

Enclosing class:

CfnAccessPoint

public static interface CfnAccessPoint.RootDirectoryProperty

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

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 it's subdirectories.

Example:

 // 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.*;
 RootDirectoryProperty rootDirectoryProperty = RootDirectoryProperty.builder()
         .creationInfo(CreationInfoProperty.builder()
                 .ownerGid("ownerGid")
                 .ownerUid("ownerUid")
                 .permissions("permissions")
                 .build())
         .path("path")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAccessPoint.RootDirectoryProperty.Builder A builder for CfnAccessPoint.RootDirectoryProperty
static class	CfnAccessPoint.RootDirectoryProperty.Jsii$Proxy An implementation for CfnAccessPoint.RootDirectoryProperty

Method Summary

Modifier and Type	Method and Description
static CfnAccessPoint.RootDirectoryProperty.Builder	builder()
default java.lang.Object	getCreationInfo() (Optional) Specifies the POSIX IDs and permissions to apply to the access point's `RootDirectory` .
default java.lang.String	getPath() 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.

Method Detail

getCreationInfo

default java.lang.Object getCreationInfo()

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

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 CreationInfo and the specified RootDirectory > Path does not exist, attempts to mount the file system using the access point will fail.

getPath

default java.lang.String getPath()

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.

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

builder

static CfnAccessPoint.RootDirectoryProperty.Builder builder()

Returns:

a CfnAccessPoint.RootDirectoryProperty.Builder of CfnAccessPoint.RootDirectoryProperty