interface RootDirectoryProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.EFS.CfnAccessPoint.RootDirectoryProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsefs#CfnAccessPoint_RootDirectoryProperty |
Java | software.amazon.awscdk.services.efs.CfnAccessPoint.RootDirectoryProperty |
Python | aws_cdk.aws_efs.CfnAccessPoint.RootDirectoryProperty |
TypeScript | aws-cdk-lib » aws_efs » 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 its subdirectories.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_efs as efs } from 'aws-cdk-lib';
const rootDirectoryProperty: efs.CfnAccessPoint.RootDirectoryProperty = {
creationInfo: {
ownerGid: 'ownerGid',
ownerUid: 'ownerUid',
permissions: 'permissions',
},
path: 'path',
};
Properties
Name | Type | Description |
---|---|---|
creation | IResolvable | Creation | (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. |
creationInfo?
Type:
IResolvable
|
Creation
(optional)
(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 specifiedRootDirectory
>Path
does not exist, attempts to mount the file system using the access point will fail.
path?
Type:
string
(optional)
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
.