Skip to content

Create Replicator

kafka_create_replicator R Documentation

Creates the replicator

Description

Creates the replicator.

Usage

kafka_create_replicator(Description, KafkaClusters, ReplicationInfoList,
  ReplicatorName, ServiceExecutionRoleArn, Tags)

Arguments

Description

A summary description of the replicator.

KafkaClusters

[required] Kafka Clusters to use in setting up sources / targets for replication.

ReplicationInfoList

[required] A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

ReplicatorName

[required] The name of the replicator. Alpha-numeric characters with '-' are allowed.

ServiceExecutionRoleArn

[required] The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)

Tags

List of tags to attach to created Replicator.

Value

A list with the following syntax:

list(
  ReplicatorArn = "string",
  ReplicatorName = "string",
  ReplicatorState = "RUNNING"|"CREATING"|"UPDATING"|"DELETING"|"FAILED"
)

Request syntax

svc$create_replicator(
  Description = "string",
  KafkaClusters = list(
    list(
      AmazonMskCluster = list(
        MskClusterArn = "string"
      ),
      VpcConfig = list(
        SecurityGroupIds = list(
          "string"
        ),
        SubnetIds = list(
          "string"
        )
      )
    )
  ),
  ReplicationInfoList = list(
    list(
      ConsumerGroupReplication = list(
        ConsumerGroupsToExclude = list(
          "string"
        ),
        ConsumerGroupsToReplicate = list(
          "string"
        ),
        DetectAndCopyNewConsumerGroups = TRUE|FALSE,
        SynchroniseConsumerGroupOffsets = TRUE|FALSE
      ),
      SourceKafkaClusterArn = "string",
      TargetCompressionType = "NONE"|"GZIP"|"SNAPPY"|"LZ4"|"ZSTD",
      TargetKafkaClusterArn = "string",
      TopicReplication = list(
        CopyAccessControlListsForTopics = TRUE|FALSE,
        CopyTopicConfigurations = TRUE|FALSE,
        DetectAndCopyNewTopics = TRUE|FALSE,
        StartingPosition = list(
          Type = "LATEST"|"EARLIEST"
        ),
        TopicsToExclude = list(
          "string"
        ),
        TopicsToReplicate = list(
          "string"
        )
      )
    )
  ),
  ReplicatorName = "string",
  ServiceExecutionRoleArn = "string",
  Tags = list(
    "string"
  )
)