libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DynamoDB.CreateGlobalTable

Description

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.

This operation only applies to Version 2017.11.29 of 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).

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.

Synopsis

Creating a Request

data CreateGlobalTable Source #

See: newCreateGlobalTable smart constructor.

Constructors

CreateGlobalTable' 

Fields

Instances

Instances details
Eq CreateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

Read CreateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

Show CreateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

Generic CreateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

Associated Types

type Rep CreateGlobalTable :: Type -> Type #

NFData CreateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

Methods

rnf :: CreateGlobalTable -> () #

Hashable CreateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

ToJSON CreateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

AWSRequest CreateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

Associated Types

type AWSResponse CreateGlobalTable #

ToHeaders CreateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

ToPath CreateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

ToQuery CreateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

type Rep CreateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

type Rep CreateGlobalTable = D1 ('MetaData "CreateGlobalTable" "Amazonka.DynamoDB.CreateGlobalTable" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "CreateGlobalTable'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "replicationGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Replica])))
type AWSResponse CreateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

newCreateGlobalTable Source #

Create a value of CreateGlobalTable with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:globalTableName:CreateGlobalTable', createGlobalTable_globalTableName - The global table name.

$sel:replicationGroup:CreateGlobalTable', createGlobalTable_replicationGroup - The Regions where the global table needs to be created.

Request Lenses

createGlobalTable_replicationGroup :: Lens' CreateGlobalTable [Replica] Source #

The Regions where the global table needs to be created.

Destructuring the Response

data CreateGlobalTableResponse Source #

See: newCreateGlobalTableResponse smart constructor.

Constructors

CreateGlobalTableResponse' 

Fields

Instances

Instances details
Eq CreateGlobalTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

Read CreateGlobalTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

Show CreateGlobalTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

Generic CreateGlobalTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

Associated Types

type Rep CreateGlobalTableResponse :: Type -> Type #

NFData CreateGlobalTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

type Rep CreateGlobalTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateGlobalTable

type Rep CreateGlobalTableResponse = D1 ('MetaData "CreateGlobalTableResponse" "Amazonka.DynamoDB.CreateGlobalTable" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "CreateGlobalTableResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalTableDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GlobalTableDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateGlobalTableResponse Source #

Create a value of CreateGlobalTableResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:globalTableDescription:CreateGlobalTableResponse', createGlobalTableResponse_globalTableDescription - Contains the details of the global table.

$sel:httpStatus:CreateGlobalTableResponse', createGlobalTableResponse_httpStatus - The response's http status code.

Response Lenses