com.amazonaws.services.fsx.model

Class LustreRootSquashConfiguration

java.lang.Object

com.amazonaws.services.fsx.model.LustreRootSquashConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LustreRootSquashConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
LustreRootSquashConfiguration()

Method Summary

Modifier and Type	Method and Description
LustreRootSquashConfiguration	clone()
boolean	equals(Object obj)
List<String>	getNoSquashNids() When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply.
String	getRootSquash() 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).
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setNoSquashNids(Collection<String> noSquashNids) When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply.
void	setRootSquash(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).
String	toString() Returns a string representation of this object.
LustreRootSquashConfiguration	withNoSquashNids(Collection<String> noSquashNids) When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply.
LustreRootSquashConfiguration	withNoSquashNids(String... noSquashNids) When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply.
LustreRootSquashConfiguration	withRootSquash(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).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LustreRootSquashConfiguration

public LustreRootSquashConfiguration()

Method Detail

setRootSquash

public void setRootSquash(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.

Parameters:

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.

getRootSquash

public String getRootSquash()

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.

withRootSquash

public LustreRootSquashConfiguration withRootSquash(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getNoSquashNids

public List<String> getNoSquashNids()

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).

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).

setNoSquashNids

public void setNoSquashNids(Collection<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).

Parameters:

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).

withNoSquashNids

public LustreRootSquashConfiguration withNoSquashNids(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).

NOTE: This method appends the values to the existing list (if any). Use setNoSquashNids(java.util.Collection) or withNoSquashNids(java.util.Collection) if you want to override the existing values.

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

withNoSquashNids

public LustreRootSquashConfiguration withNoSquashNids(Collection<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).

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public LustreRootSquashConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.