location_efs

Creates, updates, deletes, gets or lists a location_efs resource.

Overview

Name	location_efs
Type	Resource
Id	aws.datasync.location_efs

Fields

The following fields are returned by SELECT queries:

describe_location_efs

Name	Datatype	Description
access_point_arn	string	The ARN of the access point that DataSync uses to access the Amazon EFS file system. For more information, see Accessing restricted file systems. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):elasticfilesystem:[a-z-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$</code>)
creation_time	string (date-time)	The time that the location was created.
ec_2_config	object	The subnet and security groups that DataSync uses to connect to one of your Amazon EFS file system's mount targets.
file_system_access_role_arn	string	The Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system. For more information, see Creating a DataSync IAM role for file system access. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$</code>)
in_transit_encryption	string	Indicates whether DataSync uses Transport Layer Security (TLS) encryption when transferring data to or from the Amazon EFS file system. (NONE, TLS1_2)
location_arn	string	The ARN of the Amazon EFS file system location. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$</code>)
location_uri	string	The URL of the Amazon EFS file system location. (pattern: <code>^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+):​//[a-zA-Z0-9.:/-]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_location_efs	select	region		Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.
create_location_efs	insert	region, EfsFilesystemArn, Ec2Config		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.
update_location_efs	update	region, LocationArn		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_location_efs

Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.

SELECT
access_point_arn,
creation_time,
ec_2_config,
file_system_access_role_arn,
in_transit_encryption,
location_arn,
location_uri
FROM aws.datasync.location_efs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_location_efs

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.

INSERT INTO aws.datasync.location_efs (
Subdirectory,
EfsFilesystemArn,
Ec2Config,
Tags,
AccessPointArn,
FileSystemAccessRoleArn,
InTransitEncryption,
region
)
SELECT 
'{{ Subdirectory }}',
'{{ EfsFilesystemArn }}' /* required */,
'{{ Ec2Config }}' /* required */,
'{{ Tags }}',
'{{ AccessPointArn }}',
'{{ FileSystemAccessRoleArn }}',
'{{ InTransitEncryption }}',
'{{ region }}'
RETURNING
location_arn
;

Manifest

# Description fields are for documentation purposes
- name: location_efs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the location_efs resource.
  - name: Subdirectory
    value: "{{ Subdirectory }}"
    description: |
      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).
  - name: EfsFilesystemArn
    value: "{{ EfsFilesystemArn }}"
    description: |
      Specifies the ARN for your Amazon EFS file system.
  - name: Ec2Config
    description: |
      Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system's mount targets.
    value:
      SubnetArn: "{{ SubnetArn }}"
      SecurityGroupArns:
        - "{{ SecurityGroupArns }}"
  - name: Tags
    description: |
      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.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: AccessPointArn
    value: "{{ AccessPointArn }}"
    description: |
      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 file systems.
  - name: FileSystemAccessRoleArn
    value: "{{ FileSystemAccessRoleArn }}"
    description: |
      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 file system access.
  - name: InTransitEncryption
    value: "{{ InTransitEncryption }}"
    description: |
      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.
    valid_values: ['NONE', 'TLS1_2']

UPDATE examples

update_location_efs

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.

UPDATE aws.datasync.location_efs
SET 
LocationArn = '{{ LocationArn }}',
Subdirectory = '{{ Subdirectory }}',
AccessPointArn = '{{ AccessPointArn }}',
FileSystemAccessRoleArn = '{{ FileSystemAccessRoleArn }}',
InTransitEncryption = '{{ InTransitEncryption }}'
WHERE 
region = '{{ region }}' --required
AND LocationArn = '{{ LocationArn }}' --required;