AWS CLI Command Reference

[ aws . s3tables ]

put-table-bucket-replication

Description

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 .

See also: AWS API Documentation

Synopsis

  put-table-bucket-replication
--table-bucket-arn <value>
[--version-token <value>]
--configuration <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--table-bucket-arn (string) [required]

The Amazon Resource Name (ARN) of the source table bucket.

Constraints:

  • pattern: (arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})

--version-token (string)

A version token from a previous GetTableBucketReplication call. Use this token to ensure you’re updating the expected version of the configuration.

Constraints:

  • min: 1
  • max: 2048

--configuration (structure) [required]

The replication configuration to apply, including the IAM role and replication rules.

role -> (string) [required]

The Amazon Resource Name (ARN) of the IAM role that S3 Tables assumes to replicate tables on your behalf.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:.+:iam::[0-9]{12}:role/.+

rules -> (list) [required]

An array of replication rules that define which tables to replicate and where to replicate them.

Constraints:

  • min: 1
  • max: 1

(structure)

Defines a rule for replicating tables from a source table bucket to one or more destination table buckets.

destinations -> (list) [required]

An array of destination table buckets where tables should be replicated.

Constraints:

  • min: 1
  • max: 5

(structure)

Specifies a destination table bucket for replication.

destinationTableBucketARN -> (string) [required]

The Amazon Resource Name (ARN) of the destination table bucket where tables will be replicated.

Constraints:

  • pattern: (arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})

JSON Syntax:

{
  "role": "string",
  "rules": [
    {
      "destinations": [
        {
          "destinationTableBucketARN": "string"
        }
        ...
      ]
    }
    ...
  ]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

versionToken -> (string)

A new version token representing the updated replication configuration.

Constraints:

  • min: 1
  • max: 2048

status -> (string)

The status of the replication configuration operation.
© Copyright 2025, Amazon Web Services. Created using Sphinx.