Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReplicaSettingsDescription

Represents the properties of a replica.

Hierarchy

  • ReplicaSettingsDescription

Index

Properties

RegionName

RegionName: string | undefined

The Region name of the replica.

Optional ReplicaBillingModeSummary

ReplicaBillingModeSummary: BillingModeSummary

The read/write capacity mode of the replica.

Optional ReplicaGlobalSecondaryIndexSettings

ReplicaGlobalSecondaryIndexSettings: ReplicaGlobalSecondaryIndexSettingsDescription[]

Replica global secondary index settings for the global table.

Optional ReplicaProvisionedReadCapacityAutoScalingSettings

ReplicaProvisionedReadCapacityAutoScalingSettings: AutoScalingSettingsDescription

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

Optional ReplicaProvisionedReadCapacityUnits

ReplicaProvisionedReadCapacityUnits: undefined | 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.

Optional ReplicaProvisionedWriteCapacityAutoScalingSettings

ReplicaProvisionedWriteCapacityAutoScalingSettings: AutoScalingSettingsDescription

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

Optional ReplicaProvisionedWriteCapacityUnits

ReplicaProvisionedWriteCapacityUnits: undefined | 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.

Optional ReplicaStatus

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

Optional ReplicaTableClassSummary

ReplicaTableClassSummary: TableClassSummary

Contains details of the table class.