locationf_sx_ontaps

Creates, updates, deletes or gets a locationf_sx_ontap resource or lists locationf_sx_ontaps in a region

Overview

Name	locationf_sx_ontaps
Type	Resource
Description	Resource schema for AWS::DataSync::LocationFSxONTAP.
Id	aws.datasync.locationf_sx_ontaps

Fields

Name	Datatype	Description
storage_virtual_machine_arn	string	The Amazon Resource Name (ARN) for the FSx ONTAP SVM.
fsx_filesystem_arn	string	The Amazon Resource Name (ARN) for the FSx ONAP file system.
security_group_arns	array	The ARNs of the security groups that are to use to configure the FSx ONTAP file system.
protocol	object	Configuration settings for an NFS or SMB protocol, currently only support NFS
subdirectory	string	A subdirectory in the location's path.
tags	array	An array of key-value pairs to apply to this resource.
location_arn	string	The Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.
location_uri	string	The URL of the FSx ONTAP file system that was described.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	SecurityGroupArns, StorageVirtualMachineArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all locationf_sx_ontaps in a region.

SELECT
region,
storage_virtual_machine_arn,
fsx_filesystem_arn,
security_group_arns,
protocol,
subdirectory,
tags,
location_arn,
location_uri
FROM aws.datasync.locationf_sx_ontaps
WHERE region = 'us-east-1';

Gets all properties from an individual locationf_sx_ontap.

SELECT
region,
storage_virtual_machine_arn,
fsx_filesystem_arn,
security_group_arns,
protocol,
subdirectory,
tags,
location_arn,
location_uri
FROM aws.datasync.locationf_sx_ontaps
WHERE region = 'us-east-1' AND data__Identifier = '<LocationArn>';

INSERT example

Use the following StackQL query and manifest file to create a new locationf_sx_ontap resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.datasync.locationf_sx_ontaps (
 StorageVirtualMachineArn,
 SecurityGroupArns,
 region
)
SELECT 
'{{ StorageVirtualMachineArn }}',
 '{{ SecurityGroupArns }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.datasync.locationf_sx_ontaps (
 StorageVirtualMachineArn,
 SecurityGroupArns,
 Protocol,
 Subdirectory,
 Tags,
 region
)
SELECT 
 '{{ StorageVirtualMachineArn }}',
 '{{ SecurityGroupArns }}',
 '{{ Protocol }}',
 '{{ Subdirectory }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: locationf_sx_ontap
    props:
      - name: StorageVirtualMachineArn
        value: '{{ StorageVirtualMachineArn }}'
      - name: SecurityGroupArns
        value:
          - '{{ SecurityGroupArns[0] }}'
      - name: Protocol
        value:
          NFS:
            MountOptions:
              Version: '{{ Version }}'
      - name: Subdirectory
        value: '{{ Subdirectory }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.datasync.locationf_sx_ontaps
WHERE data__Identifier = '<LocationArn>'
AND region = 'us-east-1';

Permissions

To operate on the locationf_sx_ontaps resource, the following permissions are required:

Create

datasync:CreateLocationFsxOntap,
datasync:DescribeLocationFsxOntap,
datasync:ListTagsForResource,
datasync:TagResource,
fsx:DescribeStorageVirtualMachines,
fsx:DescribeFileSystems,
ec2:DescribeNetworkInterfaces,
ec2:DescribeSubnets,
ec2:DescribeSecurityGroups

Read

datasync:DescribeLocationFsxOntap,
datasync:ListTagsForResource

Update

datasync:DescribeLocationFsxOntap,
datasync:ListTagsForResource,
datasync:TagResource,
datasync:UntagResource

Delete

datasync:DeleteLocation

List

datasync:ListLocations