file_system_associations

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

Overview

Name	file_system_associations
Type	Resource
Id	aws.storagegateway.file_system_associations

Fields

The following fields are returned by SELECT queries:

describe_file_system_associations

Name	Datatype	Description
file_system_association_info_list	array	An array containing the FileSystemAssociationInfo data type of each file system association to be described.

list_file_system_associations

Name	Datatype	Description
file_system_association_arn	string	The Amazon Resource Name (ARN) of the file system association.
file_system_association_id	string	The ID of the file system association.
file_system_association_status	string	The status of the file share. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR
gateway_arn	string	The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_file_system_associations	select	region		Gets the file system association information. This operation is only supported for FSx File Gateways.
list_file_system_associations	select	region		Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.
update_file_system_association	update	region, FileSystemAssociationARN		Updates a file system association. This operation is only supported in the FSx File Gateways.

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)

SELECT examples

describe_file_system_associations

Gets the file system association information. This operation is only supported for FSx File Gateways.

SELECT
file_system_association_info_list
FROM aws.storagegateway.file_system_associations
WHERE region = '{{ region }}' -- required
;

list_file_system_associations

Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.

SELECT
file_system_association_arn,
file_system_association_id,
file_system_association_status,
gateway_arn
FROM aws.storagegateway.file_system_associations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_file_system_association

Updates a file system association. This operation is only supported in the FSx File Gateways.

UPDATE aws.storagegateway.file_system_associations
SET 
FileSystemAssociationARN = '{{ FileSystemAssociationARN }}',
UserName = '{{ UserName }}',
Password = '{{ Password }}',
AuditDestinationARN = '{{ AuditDestinationARN }}',
CacheAttributes = '{{ CacheAttributes }}'
WHERE 
region = '{{ region }}' --required
AND FileSystemAssociationARN = '{{ FileSystemAssociationARN }}' --required
RETURNING
file_system_association_arn;