Smaws_Client_DynamoDB.UpdateGlobalTable
val request :
Smaws_Lib.Context.t ->
update_global_table_input ->
(update_global_table_output,
[> Smaws_Lib.Protocols.AwsJson.error
| `GlobalTableNotFoundException of global_table_not_found_exception
| `InternalServerError of internal_server_error
| `InvalidEndpointException of invalid_endpoint_exception
| `ReplicaAlreadyExistsException of replica_already_exists_exception
| `ReplicaNotFoundException of replica_not_found_exception
| `TableNotFoundException of table_not_found_exception ])
Stdlib.result
Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.
This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). If you are using global tables Version 2019.11.21 you can use UpdateTable instead.
Although you can use UpdateGlobalTable
to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.
If global secondary indexes are specified, then the following conditions must also be met: