Describe Replicator

kafka_describe_replicator

R Documentation

Describes a replicator

Description

Describes a replicator.

Usage

kafka_describe_replicator(ReplicatorArn)

Arguments

ReplicatorArn

[required] The Amazon Resource Name (ARN) of the replicator to be described.

Value

A list with the following syntax:

list(
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  CurrentVersion = "string",
  IsReplicatorReference = TRUE|FALSE,
  KafkaClusters = list(
    list(
      AmazonMskCluster = list(
        MskClusterArn = "string"
      ),
      ApacheKafkaCluster = list(
        ApacheKafkaClusterId = "string",
        BootstrapBrokerString = "string"
      ),
      KafkaClusterAlias = "string",
      VpcConfig = list(
        SecurityGroupIds = list(
          "string"
        ),
        SubnetIds = list(
          "string"
        )
      ),
      ClientAuthentication = list(
        SaslScram = list(
          Mechanism = "SHA256"|"SHA512",
          SecretArn = "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"
      ),
      SourceKafkaClusterAlias = "string",
      TargetCompressionType = "NONE"|"GZIP"|"SNAPPY"|"LZ4"|"ZSTD",
      TargetKafkaClusterAlias = "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"
        )
      )
    )
  ),
  ReplicatorArn = "string",
  ReplicatorDescription = "string",
  ReplicatorName = "string",
  ReplicatorResourceArn = "string",
  ReplicatorState = "RUNNING"|"CREATING"|"UPDATING"|"DELETING"|"FAILED",
  ServiceExecutionRoleArn = "string",
  StateInfo = list(
    Code = "string",
    Message = "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"
      )
    )
  )
)

Request syntax

svc$describe_replicator(
  ReplicatorArn = "string"
)