software.amazon.awssdk.services.datasync.model

Class CreateLocationNfsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datasync.model.DataSyncRequest

software.amazon.awssdk.services.datasync.model.CreateLocationNfsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLocationNfsRequest.Builder,CreateLocationNfsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateLocationNfsRequest
extends DataSyncRequest
implements ToCopyableBuilder<CreateLocationNfsRequest.Builder,CreateLocationNfsRequest>

CreateLocationNfsRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateLocationNfsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateLocationNfsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
NfsMountOptions	mountOptions() The NFS mount options that DataSync can use to mount your NFS share.
OnPremConfig	onPremConfig() Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateLocationNfsRequest.Builder>	serializableBuilderClass()
String	serverHostname() The name of the NFS server.
String	subdirectory() The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.
List<TagListEntry>	tags() The key-value pair that represents the tag that you want to add to the location.
CreateLocationNfsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

subdirectory

public String subdirectory()

The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.

To see all the paths exported by your NFS server. run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.

Returns:

The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.

To see all the paths exported by your NFS server. run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.

serverHostname

public String serverHostname()

The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this host name to mount the NFS server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Returns:

The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this host name to mount the NFS server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

onPremConfig

public OnPremConfig onPremConfig()

Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.

Returns:

Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.

mountOptions

public NfsMountOptions mountOptions()

The NFS mount options that DataSync can use to mount your NFS share.

Returns:

The NFS mount options that DataSync can use to mount your NFS share.

hasTags

public boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public List<TagListEntry> tags()

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

toBuilder

public CreateLocationNfsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateLocationNfsRequest.Builder,CreateLocationNfsRequest>

Specified by:

toBuilder in class DataSyncRequest

builder

public static CreateLocationNfsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo