synchronization_configurations

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

Overview

Name	synchronization_configurations
Type	Resource
Id	aws.s3files.synchronization_configurations

Fields

The following fields are returned by SELECT queries:

get_synchronization_configuration

Name	Datatype	Description
expiration_data_rules	array	An array of expiration data rules that control when cached data expires from the file system.
import_data_rules	array	An array of import data rules that control how data is imported from S3 into the file system.
latest_version_number	integer	The version number of the synchronization configuration. Use this value with PutSynchronizationConfiguration to ensure optimistic concurrency control.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_synchronization_configuration	select	file_system_id, region		Returns the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.
put_synchronization_configuration	replace	file_system_id, region, importDataRules, expirationDataRules		Creates or updates the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.

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
file_system_id	string	The ID or Amazon Resource Name (ARN) of the S3 File System to configure synchronization for.
region	string	AWS region (default: us-east-1)

SELECT examples

get_synchronization_configuration

Returns the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.

SELECT
expiration_data_rules,
import_data_rules,
latest_version_number
FROM aws.s3files.synchronization_configurations
WHERE file_system_id = '{{ file_system_id }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_synchronization_configuration

Creates or updates the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.

REPLACE aws.s3files.synchronization_configurations
SET 
latestVersionNumber = {{ latestVersionNumber }},
importDataRules = '{{ importDataRules }}',
expirationDataRules = '{{ expirationDataRules }}'
WHERE 
file_system_id = '{{ file_system_id }}' --required
AND region = '{{ region }}' --required
AND importDataRules = '{{ importDataRules }}' --required
AND expirationDataRules = '{{ expirationDataRules }}' --required;