Class LustreRootSquashConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LustreRootSquashConfiguration.Builder,
LustreRootSquashConfiguration>
The configuration for Lustre root squash used to restrict root-level access from clients that try to access your FSx
for Lustre file system as root. Use the RootSquash
parameter to enable root squash. To learn more about
Lustre root squash, see Lustre root
squash.
You can also use the NoSquashNids
parameter to provide an array of clients who are not affected by the
root squash setting. These clients will access the file system as root, with unrestricted privileges.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
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 boolean
For responses, this returns true if the service returned a value for the NoSquashNids property.When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply.final String
You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the formatUID:GID
(for example,365534:65534
).static Class
<? extends LustreRootSquashConfiguration.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
-
rootSquash
You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format
UID:GID
(for example,365534:65534
). The UID and GID values can range from0
to4294967294
:-
A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.
-
A value of
0
(zero) for UID and GID indicates root, and therefore disables root squash.
When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.
- Returns:
- You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format
UID:GID
(for example,365534:65534
). The UID and GID values can range from0
to4294967294
:-
A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.
-
A value of
0
(zero) for UID and GID indicates root, and therefore disables root squash.
When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.
-
-
-
hasNoSquashNids
public final boolean hasNoSquashNids()For responses, this returns true if the service returned a value for the NoSquashNids property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
noSquashNids
When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:
-
A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example,
10.0.1.6@tcp
). -
An address range is described using a dash to separate the range (for example,
10.0.[2-10].[1-255]@tcp
).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasNoSquashNids()
method.- Returns:
- When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash
does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can
specify the NID as either a single address or a range of addresses:
-
A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example,
10.0.1.6@tcp
). -
An address range is described using a dash to separate the range (for example,
10.0.[2-10].[1-255]@tcp
).
-
-
-
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<LustreRootSquashConfiguration.Builder,
LustreRootSquashConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
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
-
getValueForField
-
sdkFields
-