import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient"; import type { CreateGlobalTableInput, CreateGlobalTableOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link CreateGlobalTableCommand}. */ export interface CreateGlobalTableCommandInput extends CreateGlobalTableInput { } /** * @public * * The output of {@link CreateGlobalTableCommand}. */ export interface CreateGlobalTableCommandOutput extends CreateGlobalTableOutput, __MetadataBearer { } declare const CreateGlobalTableCommand_base: { new (input: CreateGlobalTableCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: CreateGlobalTableCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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 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:

* *

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

* *

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

* * *

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.

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { DynamoDBClient, CreateGlobalTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import * // const { DynamoDBClient, CreateGlobalTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import * // import type { DynamoDBClientConfig } from "@aws-sdk/client-dynamodb"; * const config = {}; // type is DynamoDBClientConfig * const client = new DynamoDBClient(config); * const input = { // CreateGlobalTableInput * GlobalTableName: "STRING_VALUE", // required * ReplicationGroup: [ // ReplicaList // required * { // Replica * RegionName: "STRING_VALUE", * }, * ], * }; * const command = new CreateGlobalTableCommand(input); * const response = await client.send(command); * // { // CreateGlobalTableOutput * // GlobalTableDescription: { // GlobalTableDescription * // ReplicationGroup: [ // ReplicaDescriptionList * // { // ReplicaDescription * // RegionName: "STRING_VALUE", * // ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED" || "REPLICATION_NOT_AUTHORIZED", * // ReplicaArn: "STRING_VALUE", * // ReplicaStatusDescription: "STRING_VALUE", * // ReplicaStatusPercentProgress: "STRING_VALUE", * // KMSMasterKeyId: "STRING_VALUE", * // ProvisionedThroughputOverride: { // ProvisionedThroughputOverride * // ReadCapacityUnits: Number("long"), * // }, * // OnDemandThroughputOverride: { // OnDemandThroughputOverride * // MaxReadRequestUnits: Number("long"), * // }, * // WarmThroughput: { // TableWarmThroughputDescription * // ReadUnitsPerSecond: Number("long"), * // WriteUnitsPerSecond: Number("long"), * // Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED" || "REPLICATION_NOT_AUTHORIZED", * // }, * // GlobalSecondaryIndexes: [ // ReplicaGlobalSecondaryIndexDescriptionList * // { // ReplicaGlobalSecondaryIndexDescription * // IndexName: "STRING_VALUE", * // ProvisionedThroughputOverride: { * // ReadCapacityUnits: Number("long"), * // }, * // OnDemandThroughputOverride: { * // MaxReadRequestUnits: Number("long"), * // }, * // WarmThroughput: { // GlobalSecondaryIndexWarmThroughputDescription * // ReadUnitsPerSecond: Number("long"), * // WriteUnitsPerSecond: Number("long"), * // Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE", * // }, * // }, * // ], * // ReplicaInaccessibleDateTime: new Date("TIMESTAMP"), * // ReplicaTableClassSummary: { // TableClassSummary * // TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS", * // LastUpdateDateTime: new Date("TIMESTAMP"), * // }, * // GlobalTableSettingsReplicationMode: "ENABLED" || "DISABLED" || "ENABLED_WITH_OVERRIDES", * // }, * // ], * // GlobalTableArn: "STRING_VALUE", * // CreationDateTime: new Date("TIMESTAMP"), * // GlobalTableStatus: "CREATING" || "ACTIVE" || "DELETING" || "UPDATING", * // GlobalTableName: "STRING_VALUE", * // }, * // }; * * ``` * * @param CreateGlobalTableCommandInput - {@link CreateGlobalTableCommandInput} * @returns {@link CreateGlobalTableCommandOutput} * @see {@link CreateGlobalTableCommandInput} for command's `input` shape. * @see {@link CreateGlobalTableCommandOutput} for command's `response` shape. * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape. * * @throws {@link GlobalTableAlreadyExistsException} (client fault) *

The specified global table already exists.

* * @throws {@link InternalServerError} (server fault) *

An error occurred on the server side.

* * @throws {@link InvalidEndpointException} (client fault) * * @throws {@link LimitExceededException} (client fault) *

There is no limit to the number of daily on-demand backups that can be taken.

*

For most purposes, up to 500 simultaneous table operations are allowed per account. * These operations include CreateTable, UpdateTable, * DeleteTable,UpdateTimeToLive, * RestoreTableFromBackup, and RestoreTableToPointInTime.

*

When you are creating a table with one or more secondary indexes, you can have up * to 250 such requests running at a time. However, if the table or index specifications * are complex, then DynamoDB might temporarily reduce the number of concurrent * operations.

*

When importing into DynamoDB, up to 50 simultaneous import table operations are * allowed per account.

*

There is a soft account quota of 2,500 tables.

*

GetRecords was called with a value of more than 1000 for the limit request * parameter.

*

More than 2 processes are reading from the same streams shard at the same time. * Exceeding this limit may result in request throttling.

* * @throws {@link TableNotFoundException} (client fault) *

A source table with the name TableName does not currently exist within * the subscriber's account or the subscriber is operating in the wrong Amazon Web Services * Region.

* * @throws {@link DynamoDBServiceException} *

Base exception class for all service exceptions from DynamoDB service.

* * * @public */ export declare class CreateGlobalTableCommand extends CreateGlobalTableCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateGlobalTableInput; output: CreateGlobalTableOutput; }; sdk: { input: CreateGlobalTableCommandInput; output: CreateGlobalTableCommandOutput; }; }; }