AWS DataSync

{'AccessPointArn': 'string',
 'FileSystemAccessRoleArn': 'string',
 'InTransitEncryption': 'NONE | TLS1_2'}

Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see Creating a location for Amazon EFS.

See also: AWS API Documentation

Request Syntax

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'
)

type Subdirectory

string

param Subdirectory

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

type EfsFilesystemArn

string

param EfsFilesystemArn

[REQUIRED]

Specifies the ARN for the Amazon EFS file system.

type Ec2Config

dict

param Ec2Config

[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) --

type Tags

list

param Tags

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

  Represents a single entry in a list of Amazon Web Services resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

  • Key (string) -- [REQUIRED]

    The key for an Amazon Web Services resource tag.

  • Value (string) --

    The value for an Amazon Web Services resource tag.

type AccessPointArn

string

param AccessPointArn

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

type FileSystemAccessRoleArn

string

param FileSystemAccessRoleArn

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

type InTransitEncryption

string

param InTransitEncryption

Specifies whether you want DataSync to use TLS encryption when transferring 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

{
    'LocationArn': 'string'
}

Response Structure

• (dict) --

  CreateLocationEfs

  • LocationArn (string) --

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

{'AccessPointArn': 'string',
 'FileSystemAccessRoleArn': 'string',
 'InTransitEncryption': 'NONE | TLS1_2'}

Returns metadata about your DataSync location for an Amazon EFS file system.

See also: AWS API Documentation

Request Syntax

client.describe_location_efs(
    LocationArn='string'
)

type LocationArn

string

param LocationArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'Ec2Config': {
        'SubnetArn': 'string',
        'SecurityGroupArns': [
            'string',
        ]
    },
    'CreationTime': datetime(2015, 1, 1),
    'AccessPointArn': 'string',
    'FileSystemAccessRoleArn': 'string',
    'InTransitEncryption': 'NONE'|'TLS1_2'
}

Response Structure

• (dict) --

  DescribeLocationEfsResponse

  • LocationArn (string) --

    The ARN of the Amazon EFS file system location.

  • LocationUri (string) --

    The URL of the Amazon EFS file system location.

  • Ec2Config (dict) --

    The subnet and security groups that DataSync uses to access your Amazon EFS file system.

    • SubnetArn (string) --

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

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

      • (string) --

  • CreationTime (datetime) --

    The time that the location was created.

  • AccessPointArn (string) --

    The ARN of the access point that DataSync uses to access the Amazon EFS file system.

  • FileSystemAccessRoleArn (string) --

    The Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

  • InTransitEncryption (string) --

    Whether DataSync uses TLS encryption when transferring data to or from your Amazon EFS file system.