ReplicaDescription - Amazon DynamoDB

ReplicaDescription

Contains the details of the replica.

Contents

Note

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

GlobalSecondaryIndexes

Replica-specific global secondary index settings.

Type: Array of ReplicaGlobalSecondaryIndexDescription objects

Required: No

KMSMasterKeyId

The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.

Type: String

Required: No

ProvisionedThroughputOverride

Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.

Type: ProvisionedThroughputOverride object

Required: No

RegionName

The name of the Region.

Type: String

Required: No

ReplicaStatus

The current state of the replica:

  • CREATING - The replica is being created.

  • UPDATING - The replica is being updated.

  • DELETING - The replica is being deleted.

  • ACTIVE - The replica is ready for use.

Type: String

Valid Values: CREATING | CREATION_FAILED | UPDATING | DELETING | ACTIVE

Required: No

ReplicaStatusDescription

Detailed information about the replica status.

Type: String

Required: No

ReplicaStatusPercentProgress

Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.

Type: String

Required: No

See Also

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