Skip to content

Creates the replicator

Description

Creates the replicator.

Usage

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

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.

  • LogDelivery

    Configuration for delivering replicator logs to customer destinations.

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"
      ),
      ApacheKafkaCluster = list(
        ApacheKafkaClusterId = "string",
        BootstrapBrokerString = "string"
      ),
      VpcConfig = list(
        SecurityGroupIds = list(
          "string"
        ),
        SubnetIds = list(
          "string"
        )
      ),
      ClientAuthentication = list(
        SaslScram = list(
          Mechanism = "SHA256"|"SHA512",
          SecretArn = "string"
        ),
        MTLS = list(
          SecretArn = "string"
        ),
        SaslOAuthBearer = list(
          TokenEndpointUrl = "string",
          ClientCredentials = list(
            TokenRequestSecretArn = "string"
          ),
          IamJwtBearer = list(
            Audience = "string",
            SigningAlgorithm = "RS256"|"ES384",
            TokenRequestSecretArn = "string"
          ),
          ClientCredentialsAssertion = list(
            Audience = "string",
            SigningAlgorithm = "RS256"|"ES384",
            TokenRequestSecretArn = "string"
          ),
          TokenEndpointAuthenticationMethod = "POST"|"BASIC"|"NONE",
          Scope = "string",
          TokenEndpointTlsCertificateArn = "string"
        )
      ),
      EncryptionInTransit = list(
        EncryptionType = "TLS",
        RootCaCertificate = "string"
      )
    )
  ),
  ReplicationInfoList = list(
    list(
      ConsumerGroupReplication = list(
        ConsumerGroupsToExclude = list(
          "string"
        ),
        ConsumerGroupsToReplicate = list(
          "string"
        ),
        DetectAndCopyNewConsumerGroups = TRUE|FALSE,
        SynchroniseConsumerGroupOffsets = TRUE|FALSE,
        ConsumerGroupOffsetSyncMode = "LEGACY"|"ENHANCED"
      ),
      SourceKafkaClusterArn = "string",
      SourceKafkaClusterId = "string",
      TargetCompressionType = "NONE"|"GZIP"|"SNAPPY"|"LZ4"|"ZSTD",
      TargetKafkaClusterArn = "string",
      TargetKafkaClusterId = "string",
      TopicReplication = list(
        CopyAccessControlListsForTopics = TRUE|FALSE,
        CopyTopicConfigurations = TRUE|FALSE,
        DetectAndCopyNewTopics = TRUE|FALSE,
        StartingPosition = list(
          Type = "LATEST"|"EARLIEST"
        ),
        TopicNameConfiguration = list(
          Type = "PREFIXED_WITH_SOURCE_CLUSTER_ALIAS"|"IDENTICAL"
        ),
        TopicsToExclude = list(
          "string"
        ),
        TopicsToReplicate = list(
          "string"
        )
      )
    )
  ),
  ReplicatorName = "string",
  ServiceExecutionRoleArn = "string",
  Tags = list(
    "string"
  ),
  LogDelivery = list(
    ReplicatorLogDelivery = list(
      CloudWatchLogs = list(
        Enabled = TRUE|FALSE,
        LogGroup = "string"
      ),
      Firehose = list(
        Enabled = TRUE|FALSE,
        DeliveryStream = "string"
      ),
      S3 = list(
        Enabled = TRUE|FALSE,
        Bucket = "string",
        Prefix = "string"
      )
    )
  )
)