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

Name	locationf_sx_open_zfs
Type	Resource
Description	Resource schema for AWS::DataSync::LocationFSxOpenZFS.
Id	awscc.datasync.locationf_sx_open_zfs

Fields

get (all properties)

Name	Datatype	Description
fsx_filesystem_arn	string	The Amazon Resource Name (ARN) for the FSx OpenZFS file system.
security_group_arns	array	The ARNs of the security groups that are to use to configure the FSx OpenZFS 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 OpenZFS file system location that is created.
location_uri	string	The URL of the FSx OpenZFS that was described.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
location_arn	string	The Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created.
region	string	AWS region.

For more information, see AWS::DataSync::LocationFSxOpenZFS.

Methods

Name	Resource	Accessible by	Required Params
create_resource	locationf_sx_open_zfs	INSERT	SecurityGroupArns, Protocol, region
delete_resource	locationf_sx_open_zfs	DELETE	Identifier, region
update_resource	locationf_sx_open_zfs	UPDATE	Identifier, PatchDocument, region
list_resources	locationf_sx_open_zfs_list_only	SELECT	region
get_resource	locationf_sx_open_zfs	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.datasync.locationf_sx_open_zfs
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ location_arn }}';

list (identifiers only)

Lists all locationf_sx_open_zfs in a region.

SELECT
  region,
  location_arn
FROM awscc.datasync.locationf_sx_open_zfs_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.datasync.locationf_sx_open_zfs (
  FsxFilesystemArn,
  SecurityGroupArns,
  Protocol,
  Subdirectory,
  Tags,
  region
)
SELECT
  '{{ fsx_filesystem_arn }}',
  '{{ security_group_arns }}',
  '{{ 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_open_zf
    props:
      - name: fsx_filesystem_arn
        value: '{{ fsx_filesystem_arn }}'
      - name: security_group_arns
        value:
          - '{{ security_group_arns[0] }}'
      - name: protocol
        value:
          n_fs:
            mount_options:
              version: '{{ version }}'
      - name: subdirectory
        value: '{{ subdirectory }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a locationf_sx_open_zf resource, using stack-deploy.

/*+ update */
UPDATE awscc.datasync.locationf_sx_open_zfs
SET PatchDocument = string('{{ {
    "Protocol": protocol,
    "Subdirectory": subdirectory,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ location_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.datasync.locationf_sx_open_zfs
WHERE
  Identifier = '{{ location_arn }}' 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:UpdateLocationFsxOpenZfs,
datasync:ListTagsForResource,
datasync:TagResource,
datasync:UntagResource,
fsx:DescribeFileSystems,
ec2:DescribeNetworkInterfaces

Delete

datasync:DeleteLocation

List

datasync:ListLocations