table_bucket_replications

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

Overview

Name	table_bucket_replications
Type	Resource
Id	aws.s3tables.table_bucket_replications

Fields

The following fields are returned by SELECT queries:

get_table_bucket_replication

Name	Datatype	Description
configuration	object	The replication configuration for the table bucket, including the IAM role and replication rules.
version_token	string	A version token that represents the current state of the replication configuration. Use this token when updating the configuration to ensure consistency.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_table_bucket_replication	select	tableBucketARN, region		Retrieves the replication configuration for a table bucket.This operation returns the IAM role, versionToken, and replication rules that define how tables in this bucket are replicated to other buckets. Permissions You must have the s3tables:GetTableBucketReplication permission to use this operation.
put_table_bucket_replication	replace	tableBucketARN, region, configuration	versionToken	Creates or updates the replication configuration for a table bucket. This operation defines how tables in the source bucket are replicated to destination buckets. Replication helps ensure data availability and disaster recovery across regions or accounts. Permissions You must have the s3tables:PutTableBucketReplication permission to use this operation. The IAM role specified in the configuration must have permissions to read from the source bucket and write permissions to all destination buckets. You must also have the following permissions: s3tables:GetTable permission on the source table. s3tables:ListTables permission on the bucket containing the table. s3tables:CreateTable permission for the destination. s3tables:CreateNamespace permission for the destination. s3tables:GetTableMaintenanceConfig permission for the source bucket. s3tables:PutTableMaintenanceConfig permission for the destination bucket. You must have iam:PassRole permission with condition allowing roles to be passed to replication.s3tables.amazonaws.com.
delete_table_bucket_replication	delete	tableBucketARN, region	versionToken	Deletes the replication configuration for a table bucket. After deletion, new table updates will no longer be replicated to destination buckets, though existing replicated tables will remain in destination buckets. Permissions You must have the s3tables:DeleteTableBucketReplication permission to use this operation.

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)
tableBucketARN	string	The Amazon Resource Name (ARN) of the table bucket.
versionToken	string	A version token from a previous GetTableBucketReplication call. Use this token to ensure you're deleting the expected version of the configuration.

SELECT examples

get_table_bucket_replication

Retrieves the replication configuration for a table bucket.This operation returns the IAM role, versionToken, and replication rules that define how tables in this bucket are replicated to other buckets. Permissions You must have the s3tables:GetTableBucketReplication permission to use this operation.

SELECT
configuration,
version_token
FROM aws.s3tables.table_bucket_replications
WHERE tableBucketARN = '{{ tableBucketARN }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_table_bucket_replication

Creates or updates the replication configuration for a table bucket. This operation defines how tables in the source bucket are replicated to destination buckets. Replication helps ensure data availability and disaster recovery across regions or accounts. Permissions You must have the s3tables:PutTableBucketReplication permission to use this operation. The IAM role specified in the configuration must have permissions to read from the source bucket and write permissions to all destination buckets. You must also have the following permissions: s3tables:GetTable permission on the source table. s3tables:ListTables permission on the bucket containing the table. s3tables:CreateTable permission for the destination. s3tables:CreateNamespace permission for the destination. s3tables:GetTableMaintenanceConfig permission for the source bucket. s3tables:PutTableMaintenanceConfig permission for the destination bucket. You must have iam:PassRole permission with condition allowing roles to be passed to replication.s3tables.amazonaws.com.

REPLACE aws.s3tables.table_bucket_replications
SET 
configuration = '{{ configuration }}'
WHERE 
tableBucketARN = '{{ tableBucketARN }}' --required
AND region = '{{ region }}' --required
AND configuration = '{{ configuration }}' --required
AND versionToken = '{{ versionToken}}'
RETURNING
status,
version_token;

DELETE examples

delete_table_bucket_replication

Deletes the replication configuration for a table bucket. After deletion, new table updates will no longer be replicated to destination buckets, though existing replicated tables will remain in destination buckets. Permissions You must have the s3tables:DeleteTableBucketReplication permission to use this operation.

DELETE FROM aws.s3tables.table_bucket_replications
WHERE tableBucketARN = '{{ tableBucketARN }}' --required
AND region = '{{ region }}' --required
AND versionToken = '{{ versionToken }}'
;