Class RootDirectory
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RootDirectory.Builder,
RootDirectory>
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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic RootDirectory.Builder
builder()
final CreationInfo
(Optional) Specifies the POSIX IDs and permissions to apply to the access point'sRootDirectory
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
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.static Class
<? extends RootDirectory.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the
CreationInfo
.- Returns:
- 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
.
-
creationInfo
(Optional) Specifies the POSIX IDs and permissions to apply to the access point's
RootDirectory
. If theRootDirectory
>Path
specified does not exist, EFS creates the root directory using theCreationInfo
settings when a client connects to an access point. When specifying theCreationInfo
, 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.- Returns:
- (Optional) Specifies the POSIX IDs and permissions to apply to the access point's
RootDirectory
. If theRootDirectory
>Path
specified does not exist, EFS creates the root directory using theCreationInfo
settings when a client connects to an access point. When specifying theCreationInfo
, 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<RootDirectory.Builder,
RootDirectory> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-