location_fsx_lustres

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

Overview

Name	location_fsx_lustres
Type	Resource
Id	aws.datasync.location_fsx_lustres

Fields

The following fields are returned by SELECT queries:

describe_location_fsx_lustre

Name	Datatype	Description
creation_time	string (date-time)	The time that the FSx for Lustre location was created.
location_arn	string	The Amazon Resource Name (ARN) of the FSx for Lustre location that was described. (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 URI of the FSx for Lustre location that was described. (pattern: <code>^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+):​//[a-zA-Z0-9.:/-]+$</code>)
security_group_arns	array	The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Lustre file system.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_location_fsx_lustre	select	region		Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.
create_location_fsx_lustre	insert	region, FsxFilesystemArn, SecurityGroupArns		Creates a transfer location for an Amazon FSx for Lustre 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 Lustre file systems.
update_location_fsx_lustre	update	region, LocationArn		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.

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_fsx_lustre

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

SELECT
creation_time,
location_arn,
location_uri,
security_group_arns
FROM aws.datasync.location_fsx_lustres
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_location_fsx_lustre

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

INSERT INTO aws.datasync.location_fsx_lustres (
FsxFilesystemArn,
SecurityGroupArns,
Subdirectory,
Tags,
region
)
SELECT 
'{{ FsxFilesystemArn }}' /* required */,
'{{ SecurityGroupArns }}' /* required */,
'{{ Subdirectory }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
location_arn
;

Manifest

# Description fields are for documentation purposes
- name: location_fsx_lustres
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the location_fsx_lustres resource.
  - name: FsxFilesystemArn
    value: "{{ FsxFilesystemArn }}"
    description: |
      Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file system.
  - name: SecurityGroupArns
    value:
      - "{{ SecurityGroupArns }}"
    description: |
      Specifies the Amazon Resource Names (ARNs) of up to five security groups that provide access to your FSx for Lustre file system. The security groups must be able to access the file system's ports. The file system must also allow access from the security groups. For information about file system access, see the Amazon FSx for Lustre User Guide .
  - name: Subdirectory
    value: "{{ Subdirectory }}"
    description: |
      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 (/).
  - name: Tags
    description: |
      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.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_location_fsx_lustre

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.

UPDATE aws.datasync.location_fsx_lustres
SET 
LocationArn = '{{ LocationArn }}',
Subdirectory = '{{ Subdirectory }}'
WHERE 
region = '{{ region }}' --required
AND LocationArn = '{{ LocationArn }}' --required;