Skip to content

ReplicaDescription

Source code in docs_src/capo_dynamodb/types/replica_description.py
class ReplicaDescription(TypedDict, closed=True):
    region_name: NotRequired["capo_dynamodb.types.region_name.RegionName"]
    """<p>The name of the Region.</p>"""
    replica_status: NotRequired["capo_dynamodb.types.replica_status.ReplicaStatus"]
    """<p>The current state of the replica:</p> <ul> <li> <p> <code>CREATING</code> - The replica is being created.</p> </li> <li> <p> <code>UPDATING</code> - The replica is being updated.</p> </li> <li> <p> <code>DELETING</code> - The replica is being deleted.</p> </li> <li> <p> <code>ACTIVE</code> - The replica is ready for use.</p> </li> <li> <p> <code>REGION_DISABLED</code> - The replica is inaccessible because the Amazon Web Services Region has been disabled.</p> <note> <p>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.</p> </note> </li> <li> <p> <code>INACCESSIBLE_ENCRYPTION_CREDENTIALS </code> - The KMS key used to encrypt the table is inaccessible.</p> <note> <p>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.</p> </note> </li> </ul>"""
    replica_arn: NotRequired["capo_dynamodb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the global table replica.</p>"""
    replica_status_description: NotRequired[
        "capo_dynamodb.types.replica_status_description.ReplicaStatusDescription"
    ]
    """<p>Detailed information about the replica status.</p>"""
    replica_status_percent_progress: NotRequired[
        "capo_dynamodb.types.replica_status_percent_progress.ReplicaStatusPercentProgress"
    ]
    """<p>Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.</p>"""
    kms_master_key_id: NotRequired[
        "capo_dynamodb.types.kms_master_key_id.KMSMasterKeyId"
    ]
    """<p>The KMS key of the replica that will be used for KMS encryption.</p>"""
    provisioned_throughput_override: NotRequired[
        "capo_dynamodb.types.provisioned_throughput_override.ProvisionedThroughputOverride"
    ]
    """<p>Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.</p>"""
    on_demand_throughput_override: NotRequired[
        "capo_dynamodb.types.on_demand_throughput_override.OnDemandThroughputOverride"
    ]
    """<p>Overrides the maximum on-demand throughput settings for the specified replica table.</p>"""
    warm_throughput: NotRequired[
        "capo_dynamodb.types.table_warm_throughput_description.TableWarmThroughputDescription"
    ]
    """<p>Represents the warm throughput value for this replica.</p>"""
    global_secondary_indexes: NotRequired[
        "capo_dynamodb.types.replica_global_secondary_index_description_list.ReplicaGlobalSecondaryIndexDescriptionList"
    ]
    """<p>Replica-specific global secondary index settings.</p>"""
    replica_inaccessible_date_time: NotRequired["capo_dynamodb.types.date.Date"]
    """<p>The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the <code>ReplicaStatus</code> property.</p>"""
    replica_table_class_summary: NotRequired[
        "capo_dynamodb.types.table_class_summary.TableClassSummary"
    ]
    global_table_settings_replication_mode: NotRequired[
        "capo_dynamodb.types.global_table_settings_replication_mode.GlobalTableSettingsReplicationMode"
    ]
    """<p>Indicates one of the settings synchronization modes for the global table replica:</p> <ul> <li> <p> <code>ENABLED</code>: Indicates that the settings synchronization mode for the global table replica is enabled.</p> </li> <li> <p> <code>DISABLED</code>: Indicates that the settings synchronization mode for the global table replica is disabled.</p> </li> <li> <p> <code>ENABLED_WITH_OVERRIDES</code>: This mode is set by default for a same account global table. Indicates that certain global table settings can be overridden.</p> </li> </ul>"""

global_secondary_indexes instance-attribute

global_secondary_indexes: NotRequired[ReplicaGlobalSecondaryIndexDescriptionList]

Replica-specific global secondary index settings.

global_table_settings_replication_mode instance-attribute

global_table_settings_replication_mode: NotRequired[GlobalTableSettingsReplicationMode]

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 instance-attribute

kms_master_key_id: NotRequired[KMSMasterKeyId]

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

on_demand_throughput_override instance-attribute

on_demand_throughput_override: NotRequired[OnDemandThroughputOverride]

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

provisioned_throughput_override instance-attribute

provisioned_throughput_override: NotRequired[ProvisionedThroughputOverride]

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

region_name instance-attribute

region_name: NotRequired[RegionName]

The name of the Region.

replica_arn instance-attribute

replica_arn: NotRequired[String]

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

replica_inaccessible_date_time instance-attribute

replica_inaccessible_date_time: NotRequired[Date]

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

replica_status instance-attribute

replica_status: NotRequired[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.

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

    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.

    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 instance-attribute

replica_status_description: NotRequired[ReplicaStatusDescription]

Detailed information about the replica status.

replica_status_percent_progress instance-attribute

replica_status_percent_progress: NotRequired[ReplicaStatusPercentProgress]

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

replica_table_class_summary instance-attribute

replica_table_class_summary: NotRequired[TableClassSummary]

warm_throughput instance-attribute

warm_throughput: NotRequired[TableWarmThroughputDescription]

Represents the warm throughput value for this replica.