file_systems

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

Overview

Name	file_systems
Type	Resource
Id	aws.storagegateway.file_systems

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
associate_file_system	update	region, UserName, Password, ClientToken, GatewayARN, LocationARN		Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.
disassociate_file_system	update	region, FileSystemAssociationARN		Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the FSx File Gateway type.

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)

UPDATE examples

associate_file_system

Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.

UPDATE aws.storagegateway.file_systems
SET 
UserName = '{{ UserName }}',
Password = '{{ Password }}',
ClientToken = '{{ ClientToken }}',
GatewayARN = '{{ GatewayARN }}',
LocationARN = '{{ LocationARN }}',
Tags = '{{ Tags }}',
AuditDestinationARN = '{{ AuditDestinationARN }}',
CacheAttributes = '{{ CacheAttributes }}',
EndpointNetworkConfiguration = '{{ EndpointNetworkConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND UserName = '{{ UserName }}' --required
AND Password = '{{ Password }}' --required
AND ClientToken = '{{ ClientToken }}' --required
AND GatewayARN = '{{ GatewayARN }}' --required
AND LocationARN = '{{ LocationARN }}' --required
RETURNING
file_system_association_arn;

disassociate_file_system

Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the FSx File Gateway type.

UPDATE aws.storagegateway.file_systems
SET 
FileSystemAssociationARN = '{{ FileSystemAssociationARN }}',
ForceDelete = {{ ForceDelete }}
WHERE 
region = '{{ region }}' --required
AND FileSystemAssociationARN = '{{ FileSystemAssociationARN }}' --required
RETURNING
file_system_association_arn;