global_table_settings

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

Overview

Name	global_table_settings
Type	Resource
Id	aws.dynamodb.global_table_settings

Fields

The following fields are returned by SELECT queries:

describe_global_table_settings

Name	Datatype	Description
global_table_name	string	The name of the global table. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
replica_settings	array	The Region-specific settings for the global table.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_global_table_settings	select	region		Describes Region-specific settings for a global table. 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.
update_global_table_settings	update	region, GlobalTableName		Updates settings for a global table. 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.

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)

SELECT examples

describe_global_table_settings

Describes Region-specific settings for a global table. 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.

SELECT
global_table_name,
replica_settings
FROM aws.dynamodb.global_table_settings
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_global_table_settings

Updates settings for a global table. 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.

UPDATE aws.dynamodb.global_table_settings
SET 
GlobalTableName = '{{ GlobalTableName }}',
GlobalTableBillingMode = '{{ GlobalTableBillingMode }}',
GlobalTableProvisionedWriteCapacityUnits = {{ GlobalTableProvisionedWriteCapacityUnits }},
GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate = '{{ GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate }}',
GlobalTableGlobalSecondaryIndexSettingsUpdate = '{{ GlobalTableGlobalSecondaryIndexSettingsUpdate }}',
ReplicaSettingsUpdate = '{{ ReplicaSettingsUpdate }}'
WHERE 
region = '{{ region }}' --required
AND GlobalTableName = '{{ GlobalTableName }}' --required
RETURNING
global_table_name,
replica_settings;