Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface ReplicaSettingsDescription

Represents the properties of a replica.

Hierarchy

  • ReplicaSettingsDescription

Properties

RegionName: undefined | string

The Region name of the replica.

ReplicaBillingModeSummary?: BillingModeSummary

The read/write capacity mode of the replica.

ReplicaGlobalSecondaryIndexSettings?: ReplicaGlobalSecondaryIndexSettingsDescription[]

Replica global secondary index settings for the global table.

ReplicaProvisionedReadCapacityAutoScalingSettings?: AutoScalingSettingsDescription

Auto scaling settings for a global table replica's read capacity units.

ReplicaProvisionedReadCapacityUnits?: number

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.

ReplicaProvisionedWriteCapacityAutoScalingSettings?: AutoScalingSettingsDescription

Auto scaling settings for a global table replica's write capacity units.

ReplicaProvisionedWriteCapacityUnits?: number

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.

ReplicaStatus?: string

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.

ReplicaTableClassSummary?: TableClassSummary

Contains details of the table class.