create_location_nfs

DataSync.Client.create_location_nfs(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_location_nfs(
    Subdirectory='string',
    ServerHostname='string',
    OnPremConfig={
        'AgentArns': [
            'string',
        ]
    },
    MountOptions={
        'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters

• Subdirectory (string) --

  [REQUIRED]

  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 Snowcone device, see NFS Server on 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.

• ServerHostname (string) --

  [REQUIRED]

  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 hostname to mount the NFS server in a network.

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

  Note

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

• OnPremConfig (dict) --

  [REQUIRED]

  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 Snowcone device, see NFS Server on Snowcone for more information.

  • AgentArns (list) -- [REQUIRED]

    ARNs of the agents to use for an NFS location.

    • (string) --
• MountOptions (dict) --

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

  • Version (string) --

    Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.

    You can specify the following options:

    • AUTOMATIC (default): DataSync chooses NFS version 4.1.
    • NFS3 : Stateless protocol version that allows for asynchronous writes on the server.
    • NFSv4_0 : Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.
    • NFSv4_1 : Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.

    Note

    DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.

• Tags (list) --

  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.

  • (dict) --

    A key-value pair representing a single tag that's been applied to an Amazon Web Services resource.

    • Key (string) -- [REQUIRED]

      The key for an Amazon Web Services resource tag.

    • Value (string) --

      The value for an Amazon Web Services resource tag.

Return type

dict

Returns

Response Syntax

{
    'LocationArn': 'string'
}

Response Structure

• (dict) --

  CreateLocationNfsResponse

  • LocationArn (string) --

    The Amazon Resource Name (ARN) of the source NFS file system location that is created.

Exceptions

• DataSync.Client.exceptions.InvalidRequestException
• DataSync.Client.exceptions.InternalException