createLocationNfs method

Future<CreateLocationNfsResponse> createLocationNfs({ required OnPremConfig onPremConfig, required String serverHostname, required String subdirectory, NfsMountOptions? mountOptions, List<TagListEntry>? tags, })

Defines a file system on a Network File System (NFS) server that can be read from or written to.

May throw InvalidRequestException. May throw InternalException.

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

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

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

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

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

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

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

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

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

Implementation

Future<CreateLocationNfsResponse> createLocationNfs({
  required OnPremConfig onPremConfig,
  required String serverHostname,
  required String subdirectory,
  NfsMountOptions? mountOptions,
  List<TagListEntry>? tags,
}) async {
  ArgumentError.checkNotNull(onPremConfig, 'onPremConfig');
  ArgumentError.checkNotNull(serverHostname, 'serverHostname');
  _s.validateStringLength(
    'serverHostname',
    serverHostname,
    0,
    255,
    isRequired: true,
  );
  ArgumentError.checkNotNull(subdirectory, 'subdirectory');
  _s.validateStringLength(
    'subdirectory',
    subdirectory,
    0,
    4096,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'FmrsService.CreateLocationNfs'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'OnPremConfig': onPremConfig,
      'ServerHostname': serverHostname,
      'Subdirectory': subdirectory,
      if (mountOptions != null) 'MountOptions': mountOptions,
      if (tags != null) 'Tags': tags,
    },
  );

  return CreateLocationNfsResponse.fromJson(jsonResponse.body);
}