Table / Attribute / replicas

replicas#

DynamoDB.Table.replicas#
  • (list) –

    Represents replicas of the table.

    • (dict) –

      Contains the details of the replica.

      • RegionName (string) –

        The name of the Region.

      • ReplicaStatus (string) –

        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.

        • REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.

        Note

        If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

        • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.

        Note

        If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

      • ReplicaStatusDescription (string) –

        Detailed information about the replica status.

      • ReplicaStatusPercentProgress (string) –

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

      • KMSMasterKeyId (string) –

        The KMS key of the replica that will be used for KMS encryption.

      • ProvisionedThroughputOverride (dict) –

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

        • ReadCapacityUnits (integer) –

          Replica-specific read capacity units. If not specified, uses the source table’s read capacity settings.

      • OnDemandThroughputOverride (dict) –

        Overrides the maximum on-demand throughput settings for the specified replica table.

        • MaxReadRequestUnits (integer) –

          Maximum number of read request units for the specified replica table.

      • WarmThroughput (dict) –

        Represents the warm throughput value for this replica.

        • ReadUnitsPerSecond (integer) –

          Represents the base table’s warm throughput value in read units per second.

        • WriteUnitsPerSecond (integer) –

          Represents the base table’s warm throughput value in write units per second.

        • Status (string) –

          Represents warm throughput value of the base table..

      • GlobalSecondaryIndexes (list) –

        Replica-specific global secondary index settings.

        • (dict) –

          Represents the properties of a replica global secondary index.

          • IndexName (string) –

            The name of the global secondary index.

          • ProvisionedThroughputOverride (dict) –

            If not described, uses the source table GSI’s read capacity settings.

            • ReadCapacityUnits (integer) –

              Replica-specific read capacity units. If not specified, uses the source table’s read capacity settings.

          • OnDemandThroughputOverride (dict) –

            Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.

            • MaxReadRequestUnits (integer) –

              Maximum number of read request units for the specified replica table.

          • WarmThroughput (dict) –

            Represents the warm throughput of the global secondary index for this replica.

            • ReadUnitsPerSecond (integer) –

              Represents warm throughput read units per second value for a global secondary index.

            • WriteUnitsPerSecond (integer) –

              Represents warm throughput write units per second value for a global secondary index.

            • Status (string) –

              Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.

      • ReplicaInaccessibleDateTime (datetime) –

        The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.

      • ReplicaTableClassSummary (dict) –

        Contains details of the table class.

        • TableClass (string) –

          The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

        • LastUpdateDateTime (datetime) –

          The date and time at which the table class was last updated.