You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EFS::Types::RootDirectory
- Inherits:
-
Struct
- Object
- Struct
- Aws::EFS::Types::RootDirectory
- Defined in:
- (unknown)
Overview
When passing RootDirectory as input to an Aws::Client method, you can use a vanilla Hash:
{
path: "Path",
creation_info: {
owner_uid: 1, # required
owner_gid: 1, # required
permissions: "Permissions", # required
},
}
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.
Returned by:
Instance Attribute Summary collapse
-
#creation_info ⇒ Types::CreationInfo
(Optional) Specifies the POSIX IDs and permissions to apply to the access point\'s
RootDirectory
. -
#path ⇒ String
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.
Instance Attribute Details
#creation_info ⇒ Types::CreationInfo
(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.
CreationInfo
and the specified RootDirectory
> Path
does not exist, attempts to mount the file system using the
access point will fail.
#path ⇒ String
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
.