Skip to content

create_global_table

Operation

create_global_table

create_global_table(request: CreateGlobalTableInput | CreateGlobalTableInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateGlobalTableInputDict]) -> CreateGlobalTableOutput

Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.

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.

If you want to add a new replica table to a global table, each of the following conditions must be true:

  • The table must have the same primary key as all of the other replicas.

  • The table must have the same name as all of the other replicas.

  • The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.

  • None of the replica tables in the global table can contain any data.

If global secondary indexes are specified, then the following conditions must also be met:

  • The global secondary indexes must have the same name.

  • The global secondary indexes must have the same hash key and sort key (if present).

If local secondary indexes are specified, then the following conditions must also be met:

  • The local secondary indexes must have the same name.

  • The local secondary indexes must have the same hash key and sort key (if present).

Warning

Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.

If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.

Parameters:

Name Type Description Default
request CreateGlobalTableInput | CreateGlobalTableInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[CreateGlobalTableInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateGlobalTableOutput

An instance of CreateGlobalTableOutput.

create_global_table async

create_global_table(request: CreateGlobalTableInput | CreateGlobalTableInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateGlobalTableInputDict]) -> CreateGlobalTableOutput

Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.

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.

If you want to add a new replica table to a global table, each of the following conditions must be true:

  • The table must have the same primary key as all of the other replicas.

  • The table must have the same name as all of the other replicas.

  • The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.

  • None of the replica tables in the global table can contain any data.

If global secondary indexes are specified, then the following conditions must also be met:

  • The global secondary indexes must have the same name.

  • The global secondary indexes must have the same hash key and sort key (if present).

If local secondary indexes are specified, then the following conditions must also be met:

  • The local secondary indexes must have the same name.

  • The local secondary indexes must have the same hash key and sort key (if present).

Warning

Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.

If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.

Parameters:

Name Type Description Default
request CreateGlobalTableInput | CreateGlobalTableInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[CreateGlobalTableInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateGlobalTableOutput

An instance of CreateGlobalTableOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateGlobalTableInputDict

Bases: TypedDict

Dictionary form of CreateGlobalTableInput.

Attributes

global_table_name instance-attribute
global_table_name: Required[str]

The global table name.

replication_group instance-attribute
replication_group: Required[Sequence[Replica | ReplicaDict]]

The Regions where the global table needs to be created.

CreateGlobalTableInput dataclass

Bases: _SerdeShape

Dataclass for CreateGlobalTableInput structure.

Attributes

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

The global table name.

replication_group class-attribute instance-attribute
replication_group: list[Replica] | None = ...

The Regions where the global table needs to be created.

Output

CreateGlobalTableOutput dataclass

Bases: _SerdeShape

Dataclass for CreateGlobalTableOutput structure.

Attributes

global_table_description class-attribute instance-attribute
global_table_description: GlobalTableDescription | None = ...

Contains the details of the global table.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.