Menu
Amazon DynamoDB
API Reference

ReplicaSettingsDescription

Represents the properties of a replica.

Contents

Note

In the following list, the required parameters are described first.

RegionName

The region name of the replica.

Type: String

Required: Yes

ReplicaGlobalSecondaryIndexSettings

Replica global secondary index settings for the global table.

Type: Array of ReplicaGlobalSecondaryIndexSettingsDescription objects

Required: No

ReplicaProvisionedReadCapacityUnits

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

Type: Long

Valid Range: Minimum value of 1.

Required: No

ReplicaProvisionedWriteCapacityUnits

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

Type: Long

Valid Range: Minimum value of 1.

Required: No

ReplicaStatus

The current state of the region:

  • CREATING - The region is being created.

  • UPDATING - The region is being updated.

  • DELETING - The region is being deleted.

  • ACTIVE - The region is ready for use.

Type: String

Valid Values: CREATING | UPDATING | DELETING | ACTIVE

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: