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',
    SourceKafkaClusterId='string',
    TargetKafkaClusterArn='string',
    TargetKafkaClusterId='string',
    TopicReplication={
        'CopyAccessControlListsForTopics': True|False,
        'CopyTopicConfigurations': True|False,
        'DetectAndCopyNewTopics': True|False,
        'TopicsToExclude': [
            'string',
        ],
        'TopicsToReplicate': [
            'string',
        ]
    },
    LogDelivery={
        'ReplicatorLogDelivery': {
            'CloudWatchLogs': {
                'Enabled': True|False,
                'LogGroup': 'string'
            },
            'Firehose': {
                'Enabled': True|False,
                'DeliveryStream': 'string'
            },
            'S3': {
                'Enabled': True|False,
                'Bucket': 'string',
                'Prefix': '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) – The ARN of the source Kafka cluster.

• SourceKafkaClusterId (string) – The ID of the source Kafka cluster.

• TargetKafkaClusterArn (string) – The ARN of the target Kafka cluster.

• TargetKafkaClusterId (string) – The ID 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) –

• LogDelivery (dict) –

  Configuration for delivering replicator logs to customer destinations.

  • ReplicatorLogDelivery (dict) –

    Configuration for replicator log delivery.

    • CloudWatchLogs (dict) –

      Configuration for CloudWatch Logs delivery.

      • Enabled (boolean) – [REQUIRED]

        Whether log delivery to CloudWatch Logs is enabled.

      • LogGroup (string) –

        The CloudWatch log group that is the destination for log delivery.

    • Firehose (dict) –

      Configuration for Firehose delivery.

      • Enabled (boolean) – [REQUIRED]

        Whether log delivery to Firehose is enabled.

      • DeliveryStream (string) –

        The Firehose delivery stream that is the destination for log delivery.

    • S3 (dict) –

      Configuration for S3 delivery.

      • Enabled (boolean) – [REQUIRED]

        Whether log delivery to S3 is enabled.

      • Bucket (string) –

        The S3 bucket that is the destination for log delivery.

      • Prefix (string) –

        The S3 prefix that is the destination for log delivery.

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

• Kafka.Client.exceptions.BadRequestException

• Kafka.Client.exceptions.UnauthorizedException

• Kafka.Client.exceptions.InternalServerErrorException

• Kafka.Client.exceptions.ForbiddenException

• Kafka.Client.exceptions.NotFoundException

• Kafka.Client.exceptions.ServiceUnavailableException

• Kafka.Client.exceptions.TooManyRequestsException