locationf_sx_lustres

Creates, updates, deletes or gets a locationf_sx_lustre resource or lists locationf_sx_lustres in a region

Overview

Name	locationf_sx_lustres
Type	Resource
Description	Resource schema for AWS::DataSync::LocationFSxLustre.
Id	aws.datasync.locationf_sx_lustres

Fields

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	SecurityGroupArns, 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_lustres in a region.

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

Gets all properties from an individual locationf_sx_lustre.

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.datasync.locationf_sx_lustres (
 FsxFilesystemArn,
 SecurityGroupArns,
 Subdirectory,
 Tags,
 region
)
SELECT 
 '{{ FsxFilesystemArn }}',
 '{{ SecurityGroupArns }}',
 '{{ 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_lustre
    props:
      - name: FsxFilesystemArn
        value: '{{ FsxFilesystemArn }}'
      - name: SecurityGroupArns
        value:
          - '{{ SecurityGroupArns[0] }}'
      - name: Subdirectory
        value: '{{ Subdirectory }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

datasync:CreateLocationFsxLustre,
datasync:DescribeLocationFsxLustre,
datasync:ListTagsForResource,
datasync:TagResource,
fsx:DescribeFileSystems,
ec2:DescribeNetworkInterfaces,
ec2:DescribeSubnets,
ec2:DescribeSecurityGroups

Read

datasync:DescribeLocationFsxLustre,
datasync:ListTagsForResource

Update

datasync:DescribeLocationFsxLustre,
datasync:ListTagsForResource,
datasync:TagResource,
datasync:UntagResource

Delete

datasync:DeleteLocation

List

datasync:ListLocations