Kafka / Client / update_replication_info

update_replication_info#

Kafka.Client.update_replication_info(**kwargs)#

Updates replication info of a replicator.

See also: AWS API Documentation

Request Syntax

response = client.update_replication_info(
    ConsumerGroupReplication={
        'ConsumerGroupsToExclude': [
            'string',
        ],
        'ConsumerGroupsToReplicate': [
            'string',
        ],
        'DetectAndCopyNewConsumerGroups': True|False,
        'SynchroniseConsumerGroupOffsets': True|False
    },
    CurrentVersion='string',
    ReplicatorArn='string',
    SourceKafkaClusterArn='string',
    TargetKafkaClusterArn='string',
    TopicReplication={
        'CopyAccessControlListsForTopics': True|False,
        'CopyTopicConfigurations': True|False,
        'DetectAndCopyNewTopics': True|False,
        'TopicsToExclude': [
            'string',
        ],
        'TopicsToReplicate': [
            'string',
        ]
    }
)
Parameters:

  • ConsumerGroupReplication (dict) –

    Updated consumer group replication information.

    • ConsumerGroupsToExclude (list) – [REQUIRED]

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

      • (string) –

    • ConsumerGroupsToReplicate (list) – [REQUIRED]

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

      • (string) –

    • DetectAndCopyNewConsumerGroups (boolean) – [REQUIRED]

      Enables synchronization of consumer groups to target cluster.

    • SynchroniseConsumerGroupOffsets (boolean) – [REQUIRED]

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

  • CurrentVersion (string) –

    [REQUIRED]

    Current replicator version.

  • ReplicatorArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replicator to be updated.

  • SourceKafkaClusterArn (string) –

    [REQUIRED]

    The ARN of the source Kafka cluster.

  • TargetKafkaClusterArn (string) –

    [REQUIRED]

    The ARN of the target Kafka cluster.

  • TopicReplication (dict) –

    Updated topic replication information.

    • CopyAccessControlListsForTopics (boolean) – [REQUIRED]

      Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.

    • CopyTopicConfigurations (boolean) – [REQUIRED]

      Whether to periodically configure remote topics to match their corresponding upstream topics.

    • DetectAndCopyNewTopics (boolean) – [REQUIRED]

      Whether to periodically check for new topics and partitions.

    • TopicsToExclude (list) – [REQUIRED]

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

      • (string) –

    • TopicsToReplicate (list) – [REQUIRED]

      List of regular expression patterns indicating the topics to copy.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ReplicatorArn': 'string',
    'ReplicatorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED'
}

Response Structure

  • (dict) – HTTP Status Code 200: OK.

    • ReplicatorArn (string) –

      The Amazon Resource Name (ARN) of the replicator.

    • ReplicatorState (string) –

      State of the replicator.

Exceptions