Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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 <value>]
[--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>]
[--v2-debug]

Options

--table-bucket-arn (string)

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

--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.

--configuration (structure)

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

role -> (string)

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

rules -> (list)

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

(structure)

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

destinations -> (list)

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

(structure)

Specifies a destination table bucket for replication.

destinationTableBucketARN -> (string)

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

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

versionToken -> (string)

A new version token representing the updated replication configuration.

status -> (string)

The status of the replication configuration operation.