Skip to content

DynamoDB  >  Operations  >  update_global_table_settings

update_global_table_settings

Operation

update_global_table_settings async 

update_global_table_settings(input: UpdateGlobalTableSettingsInput, plugins: list[Plugin] | None = None) -> UpdateGlobalTableSettingsOutput

Updates settings for a global table.

Warning

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:

Name Type Description Default
input UpdateGlobalTableSettingsInput

An instance of UpdateGlobalTableSettingsInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
UpdateGlobalTableSettingsOutput

An instance of UpdateGlobalTableSettingsOutput.

Input

UpdateGlobalTableSettingsInput dataclass

Dataclass for UpdateGlobalTableSettingsInput structure.

Attributes

global_table_billing_mode class-attribute instance-attribute 
global_table_billing_mode: BillingMode | None = None

The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

global_table_global_secondary_index_settings_update class-attribute instance-attribute 
global_table_global_secondary_index_settings_update: list[GlobalTableGlobalSecondaryIndexSettingsUpdate] | None = None

Represents the settings of a global secondary index for a global table that will be modified.

global_table_name class-attribute instance-attribute 
global_table_name: str | None = None

The name of the global table

global_table_provisioned_write_capacity_auto_scaling_settings_update class-attribute instance-attribute 
global_table_provisioned_write_capacity_auto_scaling_settings_update: AutoScalingSettingsUpdate | None = None

Auto scaling settings for managing provisioned write capacity for the global table.

global_table_provisioned_write_capacity_units class-attribute instance-attribute 
global_table_provisioned_write_capacity_units: int | None = None

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

replica_settings_update class-attribute instance-attribute 
replica_settings_update: list[ReplicaSettingsUpdate] | None = None

Represents the settings for a global table in a Region that will be modified.

Output

UpdateGlobalTableSettingsOutput dataclass

Dataclass for UpdateGlobalTableSettingsOutput structure.

Attributes

global_table_name class-attribute instance-attribute 
global_table_name: str | None = None

The name of the global table.

replica_settings class-attribute instance-attribute 
replica_settings: list[ReplicaSettingsDescription] | None = None

The Region-specific settings for the global table.