DataSync / Client / create_location_nfs

create_location_nfs#

DataSync.Client.create_location_nfs(**kwargs)#

Creates a transfer location for a Network File System (NFS) file server. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses NFS file servers.

Note

If you’re copying data to or from an Snowcone device, you can also use CreateLocationNfs to create your transfer location. For more information, see Configuring transfers with Snowcone.

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]

    Specifies the export path in your NFS file server that you want DataSync to mount.

    This path (or a subdirectory of the path) is where DataSync transfers data to or from. For information on configuring an export for DataSync, see Accessing NFS file servers.

  • ServerHostname (string) –

    [REQUIRED]

    Specifies the Domain Name System (DNS) name or IP version 4 address of the NFS file server that your DataSync agent connects to.

  • OnPremConfig (dict) –

    [REQUIRED]

    Specifies the Amazon Resource Name (ARN) of the DataSync agent that want to connect to your NFS file server.

    You can specify more than one agent. For more information, see Using multiple agents for transfers.

    • AgentArns (list) – [REQUIRED]

      The Amazon Resource Names (ARNs) of the agents connecting to a transfer location.

      • (string) –

  • MountOptions (dict) –

    Specifies the options that DataSync can use to mount your NFS file server.

    • 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) –

    Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

    • (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 ARN of the transfer location that you created for your NFS file server.

Exceptions

  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException