AWS DataSync

Modifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with FSx for OpenZFS.

See also: AWS API Documentation

Request Syntax

client.update_location_fsx_open_zfs(
    LocationArn='string',
    Protocol={
        'NFS': {
            'MountOptions': {
                'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
            }
        },
        'SMB': {
            'Domain': 'string',
            'MountOptions': {
                'Version': 'AUTOMATIC'|'SMB2'|'SMB3'|'SMB1'|'SMB2_0'
            },
            'Password': 'string',
            'User': 'string'
        }
    },
    Subdirectory='string'
)

type LocationArn:

string

param LocationArn:

[REQUIRED]

Specifies the Amazon Resource Name (ARN) of the FSx for OpenZFS transfer location that you're updating.

type Protocol:

dict

param Protocol:

Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.

• NFS (dict) --

  Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).

  • MountOptions (dict) --

    Specifies how DataSync can access a location using the NFS protocol.

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

• SMB (dict) --

  Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.

  • Domain (string) --

    Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.

    If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.

    If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.

  • MountOptions (dict) --

    Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

    • Version (string) --

      By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

      These are the following options for configuring the SMB version:

      • AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1. This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.

      • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

      • SMB2: Restricts the protocol negotiation to only SMB version 2.1.

      • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

      • SMB1: Restricts the protocol negotiation to only SMB version 1.0.

  • Password (string) -- [REQUIRED]

    Specifies the password of a user who has permission to access your SVM.

  • User (string) -- [REQUIRED]

    Specifies a user that can mount and access the files, folders, and metadata in your SVM.

    For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.

type Subdirectory:

string

param Subdirectory:

Specifies a subdirectory in the location's path that must begin with /fsx. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Modifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with FSx for Windows File Server.

See also: AWS API Documentation

Request Syntax

client.update_location_fsx_windows(
    LocationArn='string',
    Subdirectory='string',
    Domain='string',
    User='string',
    Password='string'
)

type LocationArn:

string

param LocationArn:

[REQUIRED]

Specifies the ARN of the FSx for Windows File Server transfer location that you're updating.

type Subdirectory:

string

param Subdirectory:

Specifies a mount path for your file system using forward slashes. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).

type Domain:

string

param Domain:

Specifies the name of the Windows domain that your FSx for Windows File Server file system belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.

type User:

string

param User:

Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

For information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.

type Password:

string

param Password:

Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Modifies the following configuration parameters of the Amazon S3 transfer location that you're using with DataSync.

See also: AWS API Documentation

Request Syntax

client.update_location_s3(
    LocationArn='string',
    Subdirectory='string',
    S3StorageClass='STANDARD'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_INSTANT_RETRIEVAL',
    S3Config={
        'BucketAccessRoleArn': 'string'
    }
)

type LocationArn:

string

param LocationArn:

[REQUIRED]

Specifies the Amazon Resource Name (ARN) of the Amazon S3 transfer location that you're updating.

type Subdirectory:

string

param Subdirectory:

Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location).

type S3StorageClass:

string

param S3StorageClass:

Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.

For buckets in Amazon Web Services Regions, the storage class defaults to STANDARD. For buckets on Outposts, the storage class defaults to OUTPOSTS.

For more information, see Storage class considerations with Amazon S3 transfers.

type S3Config:

dict

param S3Config:

Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.

For more information, see Providing DataSync access to S3 buckets.

• BucketAccessRoleArn (string) -- [REQUIRED]

  Specifies the ARN of the IAM role that DataSync uses to access your S3 bucket.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Modifies the following configuration parameters of the Amazon FSx for Lustre transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with FSx for Lustre.

See also: AWS API Documentation

Request Syntax

client.update_location_fsx_lustre(
    LocationArn='string',
    Subdirectory='string'
)

type LocationArn:

string

param LocationArn:

[REQUIRED]

Specifies the Amazon Resource Name (ARN) of the FSx for Lustre transfer location that you're updating.

type Subdirectory:

string

param Subdirectory:

Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories.

When the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory ( /).

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Modifies the following configuration parameters of the Amazon EFS transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with Amazon EFS.

See also: AWS API Documentation

Request Syntax

client.update_location_efs(
    LocationArn='string',
    Subdirectory='string',
    AccessPointArn='string',
    FileSystemAccessRoleArn='string',
    InTransitEncryption='NONE'|'TLS1_2'
)

type LocationArn:

string

param LocationArn:

[REQUIRED]

Specifies the Amazon Resource Name (ARN) of the Amazon EFS transfer location that you're updating.

type Subdirectory:

string

param Subdirectory:

Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).

By default, DataSync uses the root directory (or access point if you provide one by using AccessPointArn). You can also include subdirectories using forward slashes (for example, /path/to/folder).

type AccessPointArn:

string

param AccessPointArn:

Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS file system.

For more information, see Accessing restricted Amazon EFS file systems.

type FileSystemAccessRoleArn:

string

param FileSystemAccessRoleArn:

Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.

For information on creating this role, see Creating a DataSync IAM role for Amazon EFS file system access.

type InTransitEncryption:

string

param InTransitEncryption:

Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your Amazon EFS file system.

If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with FSx for ONTAP.

See also: AWS API Documentation

Request Syntax

client.update_location_fsx_ontap(
    LocationArn='string',
    Protocol={
        'NFS': {
            'MountOptions': {
                'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
            }
        },
        'SMB': {
            'Domain': 'string',
            'MountOptions': {
                'Version': 'AUTOMATIC'|'SMB2'|'SMB3'|'SMB1'|'SMB2_0'
            },
            'Password': 'string',
            'User': 'string'
        }
    },
    Subdirectory='string'
)

type LocationArn:

string

param LocationArn:

[REQUIRED]

Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP transfer location that you're updating.

type Protocol:

dict

param Protocol:

Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.

• NFS (dict) --

  Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).

  • MountOptions (dict) --

    Specifies how DataSync can access a location using the NFS protocol.

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

• SMB (dict) --

  Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's storage virtual machine (SVM).

  • Domain (string) --

    Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.

    If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.

  • MountOptions (dict) --

    Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

    • Version (string) --

      By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

      These are the following options for configuring the SMB version:

      • AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1. This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.

      • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

      • SMB2: Restricts the protocol negotiation to only SMB version 2.1.

      • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

      • SMB1: Restricts the protocol negotiation to only SMB version 1.0.

  • Password (string) --

    Specifies the password of a user who has permission to access your SVM.

  • User (string) --

    Specifies a user that can mount and access the files, folders, and metadata in your SVM.

    For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.

type Subdirectory:

string

param Subdirectory:

Specifies a path to the file share in the storage virtual machine (SVM) where you want to transfer data to or from.

You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be /vol1, /vol1/tree1, or /share1.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --