Skip to content

ReplicaSettingsDescription

Source code in docs_src/capo_dynamodb/types/replica_settings_description.py
class ReplicaSettingsDescription(TypedDict, closed=True):
    region_name: "capo_dynamodb.types.region_name.RegionName"
    """<p>The Region name of the replica.</p>"""
    replica_status: NotRequired["capo_dynamodb.types.replica_status.ReplicaStatus"]
    """<p>The current state of the Region:</p> <ul> <li> <p> <code>CREATING</code> - The Region is being created.</p> </li> <li> <p> <code>UPDATING</code> - The Region is being updated.</p> </li> <li> <p> <code>DELETING</code> - The Region is being deleted.</p> </li> <li> <p> <code>ACTIVE</code> - The Region is ready for use.</p> </li> </ul>"""
    replica_billing_mode_summary: NotRequired[
        "capo_dynamodb.types.billing_mode_summary.BillingModeSummary"
    ]
    """<p>The read/write capacity mode of the replica.</p>"""
    replica_provisioned_read_capacity_units: NotRequired[
        "capo_dynamodb.types.non_negative_long_object.NonNegativeLongObject"
    ]
    """<p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <code>ThrottlingException</code>. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>"""
    replica_provisioned_read_capacity_auto_scaling_settings: NotRequired[
        "capo_dynamodb.types.auto_scaling_settings_description.AutoScalingSettingsDescription"
    ]
    """<p>Auto scaling settings for a global table replica's read capacity units.</p>"""
    replica_provisioned_write_capacity_units: NotRequired[
        "capo_dynamodb.types.non_negative_long_object.NonNegativeLongObject"
    ]
    """<p>The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException</code>. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"""
    replica_provisioned_write_capacity_auto_scaling_settings: NotRequired[
        "capo_dynamodb.types.auto_scaling_settings_description.AutoScalingSettingsDescription"
    ]
    """<p>Auto scaling settings for a global table replica's write capacity units.</p>"""
    replica_global_secondary_index_settings: NotRequired[
        "capo_dynamodb.types.replica_global_secondary_index_settings_description_list.ReplicaGlobalSecondaryIndexSettingsDescriptionList"
    ]
    """<p>Replica global secondary index settings for the global table.</p>"""
    replica_table_class_summary: NotRequired[
        "capo_dynamodb.types.table_class_summary.TableClassSummary"
    ]

region_name instance-attribute

region_name: RegionName

The Region name of the replica.

replica_billing_mode_summary instance-attribute

replica_billing_mode_summary: NotRequired[BillingModeSummary]

The read/write capacity mode of the replica.

replica_global_secondary_index_settings instance-attribute

replica_global_secondary_index_settings: NotRequired[
    ReplicaGlobalSecondaryIndexSettingsDescriptionList
]

Replica global secondary index settings for the global table.

replica_provisioned_read_capacity_auto_scaling_settings instance-attribute

replica_provisioned_read_capacity_auto_scaling_settings: NotRequired[
    AutoScalingSettingsDescription
]

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

replica_provisioned_read_capacity_units instance-attribute

replica_provisioned_read_capacity_units: NotRequired[NonNegativeLongObject]

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.

replica_provisioned_write_capacity_auto_scaling_settings instance-attribute

replica_provisioned_write_capacity_auto_scaling_settings: NotRequired[
    AutoScalingSettingsDescription
]

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

replica_provisioned_write_capacity_units instance-attribute

replica_provisioned_write_capacity_units: NotRequired[NonNegativeLongObject]

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.

replica_status instance-attribute

replica_status: NotRequired[ReplicaStatus]

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.

replica_table_class_summary instance-attribute

replica_table_class_summary: NotRequired[TableClassSummary]