DataSync / Client / create_location_fsx_windows

create_location_fsx_windows#

DataSync.Client.create_location_fsx_windows(**kwargs)#

Creates a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses FSx for Windows File Server file systems.

See also: AWS API Documentation

Request Syntax

response = client.create_location_fsx_windows(
    Subdirectory='string',
    FsxFilesystemArn='string',
    SecurityGroupArns=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    User='string',
    Domain='string',
    Password='string'
)
Parameters:

  • Subdirectory (string) – Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).

  • FsxFilesystemArn (string) –

    [REQUIRED]

    Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

  • SecurityGroupArns (list) –

    [REQUIRED]

    Specifies the ARNs of the Amazon EC2 security groups that provide access to your file system’s preferred subnet.

    The security groups that you specify must be able to communicate with your file system’s security groups. For information about configuring security groups for file system access, see the Amazon FSx for Windows File Server User Guide.

    Note

    If you choose a security group that doesn’t allow connections from within itself, do one of the following:

    • Configure the security group to allow it to communicate within itself.

    • Choose a different security group that can communicate with the mount target’s security group.

    • (string) –

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

  • User (string) –

    [REQUIRED]

    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.

  • Domain (string) –

    Specifies the name of the Windows domain that the 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.

  • Password (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'LocationArn': 'string'
}

Response Structure

  • (dict) –

    • LocationArn (string) –

      The ARN of the FSx for Windows File Server file system location you created.

Exceptions

  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException