Skip to main content

locationf_sx_open_zfs

Creates, updates, deletes or gets a locationf_sx_open_zf resource or lists locationf_sx_open_zfs in a region

Overview

Namelocationf_sx_open_zfs
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxOpenZFS.
Idaws.datasync.locationf_sx_open_zfs

Fields

NameDatatypeDescription
fsx_filesystem_arnstringThe Amazon Resource Name (ARN) for the FSx OpenZFS file system.
security_group_arnsarrayThe ARNs of the security groups that are to use to configure the FSx OpenZFS file system.
protocolobjectConfiguration settings for an NFS or SMB protocol, currently only support NFS
subdirectorystringA subdirectory in the location's path.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created.
location_uristringThe URL of the FSx OpenZFS that was described.
regionstringAWS region.

Methods

NameAccessible byRequired Params
create_resourceINSERTSecurityGroupArns, Protocol, region
delete_resourceDELETEdata__Identifier, region
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
list_resourcesSELECTregion
get_resourceSELECTdata__Identifier, region

SELECT examples

Gets all locationf_sx_open_zfs in a region.

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

Gets all properties from an individual locationf_sx_open_zf.

SELECT
region,
fsx_filesystem_arn,
security_group_arns,
protocol,
subdirectory,
tags,
location_arn,
location_uri
FROM aws.datasync.locationf_sx_open_zfs
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_open_zf resource, using stack-deploy.

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

DELETE example

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

Permissions

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

Create

datasync:CreateLocationFsxOpenZfs,
datasync:DescribeLocationFsxOpenZfs,
datasync:ListTagsForResource,
datasync:TagResource,
fsx:DescribeFileSystems,
ec2:DescribeNetworkInterfaces,
ec2:DescribeSubnets,
ec2:DescribeSecurityGroups

Read

datasync:DescribeLocationFsxOpenZfs,
datasync:ListTagsForResource

Update

datasync:DescribeLocationFsxOpenZfs,
datasync:ListTagsForResource,
datasync:TagResource,
datasync:UntagResource

Delete

datasync:DeleteLocation

List

datasync:ListLocations