Skip to content

DynamoDB  >  Structures  >  ReplicaDescription

ReplicaDescription

Structure Class

ReplicaDescription dataclass

Contains the details of the replica.

Attributes

global_secondary_indexes class-attribute instance-attribute 
global_secondary_indexes: list[ReplicaGlobalSecondaryIndexDescription] | None = None

Replica-specific global secondary index settings.

global_table_settings_replication_mode class-attribute instance-attribute 
global_table_settings_replication_mode: GlobalTableSettingsReplicationMode | None = None

Indicates one of the settings synchronization modes for the global table replica:

  • ENABLED: Indicates that the settings synchronization mode for the global table replica is enabled.

  • DISABLED: Indicates that the settings synchronization mode for the global table replica is disabled.

  • ENABLED_WITH_OVERRIDES: This mode is set by default for a same account global table. Indicates that certain global table settings can be overridden.

kms_master_key_id class-attribute instance-attribute 
kms_master_key_id: str | None = None

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

on_demand_throughput_override class-attribute instance-attribute 
on_demand_throughput_override: OnDemandThroughputOverride | None = None

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

provisioned_throughput_override class-attribute instance-attribute 
provisioned_throughput_override: ProvisionedThroughputOverride | None = None

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

region_name class-attribute instance-attribute 
region_name: str | None = None

The name of the Region.

replica_arn class-attribute instance-attribute 
replica_arn: str | None = None

The Amazon Resource Name (ARN) of the global table replica.

replica_inaccessible_date_time class-attribute instance-attribute 
replica_inaccessible_date_time: datetime | None = None

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

replica_status class-attribute instance-attribute 
replica_status: ReplicaStatus | None = None

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.

replica_status_description class-attribute instance-attribute 
replica_status_description: str | None = None

Detailed information about the replica status.

replica_status_percent_progress class-attribute instance-attribute 
replica_status_percent_progress: str | None = None

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

replica_table_class_summary class-attribute instance-attribute 
replica_table_class_summary: TableClassSummary | None = None

Contains details of the table class.

warm_throughput class-attribute instance-attribute 
warm_throughput: TableWarmThroughputDescription | None = None

Represents the warm throughput value for this replica.