Package software.amazon.awssdk.services.fsx.model

Class LustreRootSquashConfiguration

java.lang.Object

software.amazon.awssdk.services.fsx.model.LustreRootSquashConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LustreRootSquashConfiguration.Builder,LustreRootSquashConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class LustreRootSquashConfiguration
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LustreRootSquashConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static LustreRootSquashConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNoSquashNids()	For responses, this returns true if the service returned a value for the NoSquashNids property.
List<String>	noSquashNids()	When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply.
String	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).
List<SdkField<?>>	sdkFields()
static Class<? extends LustreRootSquashConfiguration.Builder>	serializableBuilderClass()
LustreRootSquashConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

rootSquash

public final String 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 from 0 to 4294967294:

• 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 from 0 to 4294967294:

• 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 the isEmpty() 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

public final List<String> 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

public LustreRootSquashConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LustreRootSquashConfiguration.Builder,LustreRootSquashConfiguration>

builder

public static LustreRootSquashConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends LustreRootSquashConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo