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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

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 sync 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 Centos 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 sync 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 Centos 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.

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.

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

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 interface ToCopyableBuilder<CreateLocationNfsRequest.Builder,CreateLocationNfsRequest>

Specified by:

toBuilder in class DataSyncRequest

Returns:

a builder for type T

builder

public static CreateLocationNfsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.