location_fsx_ontaps

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

Overview

Name	location_fsx_ontaps
Type	Resource
Id	aws.datasync.location_fsx_ontaps

Fields

The following fields are returned by SELECT queries:

describe_location_fsx_ontap

Name	Datatype	Description
creation_time	string (date-time)	The time that the location was created.
fsx_filesystem_arn	string	The ARN of the FSx for ONTAP file system. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$</code>)
location_arn	string	The ARN of the FSx for ONTAP 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 uniform resource identifier (URI) of the FSx for ONTAP file system location. (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 security groups that DataSync uses to access your FSx for ONTAP file system.
storage_virtual_machine_arn	string	The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system where you're copying data to or from. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_location_fsx_ontap	select	region		Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured. If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password.
create_location_fsx_ontap	insert	region, SecurityGroupArns, StorageVirtualMachineArn		Creates a transfer location for an Amazon FSx for NetApp ONTAP 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 ONTAP file systems.
update_location_fsx_ontap	update	region, LocationArn		Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for ONTAP.

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_ontap

Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured. If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password.

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

INSERT examples

create_location_fsx_ontap

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

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

Manifest

# Description fields are for documentation purposes
- name: location_fsx_ontaps
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the location_fsx_ontaps resource.
  - 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: |
      Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet. The security groups must allow outbound traffic on the following ports (depending on the protocol you use): Network File System (NFS): TCP ports 111, 635, and 2049 Server Message Block (SMB): TCP port 445 Your file system's security groups must also allow inbound traffic on the same ports.
  - name: StorageVirtualMachineArn
    value: "{{ StorageVirtualMachineArn }}"
    description: |
      Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.
  - name: Subdirectory
    value: "{{ Subdirectory }}"
    description: |
      Specifies a path to the file share in the SVM where you want to transfer data to or from. You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be /vol1, /vol1/tree1, or /share1. Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
  - 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_ontap

Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for ONTAP.

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