Skip to content

ConsumerGroupReplication

Source code in docs_src/capo_kafka/types/consumer_group_replication.py
class ConsumerGroupReplication(TypedDict, closed=True):
    consumer_groups_to_exclude: NotRequired[
        "capo_kafka.types.__list_of__string_max256.__listOf__stringMax256"
    ]
    """<p>List of regular expression patterns indicating the consumer groups that should not be replicated.</p>"""
    consumer_groups_to_replicate: NotRequired[
        "capo_kafka.types.__list_of__string_max256.__listOf__stringMax256"
    ]
    """<p>List of regular expression patterns indicating the consumer groups to copy.</p>"""
    detect_and_copy_new_consumer_groups: NotRequired[
        "capo_kafka.types.__boolean.__boolean"
    ]
    """<p>Enables synchronization of consumer groups to target cluster.</p>"""
    synchronise_consumer_group_offsets: NotRequired[
        "capo_kafka.types.__boolean.__boolean"
    ]
    """<p>Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.</p>"""
    consumer_group_offset_sync_mode: NotRequired[
        "capo_kafka.types.consumer_group_offset_sync_mode.ConsumerGroupOffsetSyncMode"
    ]
    """<p>The consumer group offset synchronization mode. With LEGACY, offsets are synchronized when producers write to the source cluster. With ENHANCED, consumer offsets are synchronized regardless of producer location. ENHANCED requires a corresponding replicator that replicates data from the target cluster to the source cluster.</p>"""

consumer_group_offset_sync_mode instance-attribute

consumer_group_offset_sync_mode: NotRequired[ConsumerGroupOffsetSyncMode]

The consumer group offset synchronization mode. With LEGACY, offsets are synchronized when producers write to the source cluster. With ENHANCED, consumer offsets are synchronized regardless of producer location. ENHANCED requires a corresponding replicator that replicates data from the target cluster to the source cluster.

consumer_groups_to_exclude instance-attribute

consumer_groups_to_exclude: NotRequired[__listOf__stringMax256]

List of regular expression patterns indicating the consumer groups that should not be replicated.

consumer_groups_to_replicate instance-attribute

consumer_groups_to_replicate: NotRequired[__listOf__stringMax256]

List of regular expression patterns indicating the consumer groups to copy.

detect_and_copy_new_consumer_groups instance-attribute

detect_and_copy_new_consumer_groups: NotRequired[__boolean]

Enables synchronization of consumer groups to target cluster.

synchronise_consumer_group_offsets instance-attribute

synchronise_consumer_group_offsets: NotRequired[__boolean]

Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.