location_fsx_open_zfs

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

Overview

Name	location_fsx_open_zfs
Type	Resource
Id	aws.datasync.location_fsx_open_zfs

Fields

The following fields are returned by SELECT queries:

describe_location_fsx_open_zfs

Name	Datatype	Description
creation_time	string (date-time)	The time that the FSx for OpenZFS location was created.
location_arn	string	The ARN of the FSx for OpenZFS 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 uniform resource identifier (URI) of the FSx for OpenZFS location that was described. Example: fsxz:​//us-west-2.fs-1234567890abcdef02/fsx/folderA/folder (pattern: <code>^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+):​//[a-zA-Z0-9.:/-]+$</code>)
protocol	object	Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
security_group_arns	array	The ARNs of the security groups that are configured for the FSx for OpenZFS file system.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_location_fsx_open_zfs	select	region		Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured. Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.
create_location_fsx_open_zfs	insert	region, FsxFilesystemArn, SecurityGroupArns		Creates a transfer location for an Amazon FSx for OpenZFS 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 OpenZFS file systems. Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.
update_location_fsx_open_zfs	update	region, LocationArn		Modifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for OpenZFS. Request parameters related to SMB aren't supported with the UpdateLocationFsxOpenZfs operation.

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_open_zfs

Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured. Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.

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

INSERT examples

create_location_fsx_open_zfs

Creates a transfer location for an Amazon FSx for OpenZFS 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 OpenZFS file systems. Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.

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

Manifest

# Description fields are for documentation purposes
- name: location_fsx_open_zfs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the location_fsx_open_zfs resource.
  - name: FsxFilesystemArn
    value: "{{ FsxFilesystemArn }}"
    description: |
      The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
  - name: Protocol
    description: |
      Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
    value:
      NFS:
        MountOptions:
          Version: "{{ Version }}"
      SMB:
        Domain: "{{ Domain }}"
        MountOptions:
          Version: "{{ Version }}"
        Password: "{{ Password }}"
        User: "{{ User }}"
        ManagedSecretConfig:
          SecretArn: "{{ SecretArn }}"
        CmkSecretConfig:
          SecretArn: "{{ SecretArn }}"
          KmsKeyArn: "{{ KmsKeyArn }}"
        CustomSecretConfig:
          SecretArn: "{{ SecretArn }}"
          SecretAccessRoleArn: "{{ SecretAccessRoleArn }}"
  - name: SecurityGroupArns
    value:
      - "{{ SecurityGroupArns }}"
    description: |
      The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.
  - name: Subdirectory
    value: "{{ Subdirectory }}"
    description: |
      A subdirectory in the location's path that must begin with /fsx. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).
  - name: Tags
    description: |
      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 }}"

UPDATE examples

update_location_fsx_open_zfs

Modifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for OpenZFS. Request parameters related to SMB aren't supported with the UpdateLocationFsxOpenZfs operation.

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