DataSync / Client / create_location_efs

create_location_efs#

DataSync.Client.create_location_efs(**kwargs)#

Creates a transfer location for an Amazon EFS 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 Amazon EFS file systems.

See also: AWS API Documentation

Request Syntax

response = client.create_location_efs(
    Subdirectory='string',
    EfsFilesystemArn='string',
    Ec2Config={
        'SubnetArn': 'string',
        'SecurityGroupArns': [
            'string',
        ]
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    AccessPointArn='string',
    FileSystemAccessRoleArn='string',
    InTransitEncryption='NONE'|'TLS1_2'
)
Parameters:

  • Subdirectory (string) –

    Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.

    Note

    You must specify a value with forward slashes (for example, /path/to/folder).

  • EfsFilesystemArn (string) –

    [REQUIRED]

    Specifies the ARN for the Amazon EFS file system.

  • Ec2Config (dict) –

    [REQUIRED]

    Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.

    • SubnetArn (string) – [REQUIRED]

      Specifies the ARN of a subnet where DataSync creates the network interfaces for managing traffic during your transfer.

      The subnet must be located:

      • In the same virtual private cloud (VPC) as the Amazon EFS file system.

      • In the same Availability Zone as at least one mount target for the Amazon EFS file system.

      Note

      You don’t need to specify a subnet that includes a file system mount target.

    • SecurityGroupArns (list) – [REQUIRED]

      Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system’s mount target.

      • (string) –

  • Tags (list) –

    Specifies the key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create 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.

  • AccessPointArn (string) – Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.

  • FileSystemAccessRoleArn (string) – Specifies an Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

  • InTransitEncryption (string) –

    Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the 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.

Return type:

dict

Returns:

Response Syntax

{
    'LocationArn': 'string'
}

Response Structure

  • (dict) –

    CreateLocationEfs

    • LocationArn (string) –

      The Amazon Resource Name (ARN) of the Amazon EFS file system location that you create.

Exceptions

  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException