Skip to content

Describe Connector

kafkaconnect_describe_connector R Documentation

Returns summary information about the connector

Description

Returns summary information about the connector.

Usage

kafkaconnect_describe_connector(connectorArn)

Arguments

connectorArn

[required] The Amazon Resource Name (ARN) of the connector that you want to describe.

Value

A list with the following syntax:

list(
  capacity = list(
    autoScaling = list(
      maxWorkerCount = 123,
      mcuCount = 123,
      minWorkerCount = 123,
      scaleInPolicy = list(
        cpuUtilizationPercentage = 123
      ),
      scaleOutPolicy = list(
        cpuUtilizationPercentage = 123
      )
    ),
    provisionedCapacity = list(
      mcuCount = 123,
      workerCount = 123
    )
  ),
  connectorArn = "string",
  connectorConfiguration = list(
    "string"
  ),
  connectorDescription = "string",
  connectorName = "string",
  connectorState = "RUNNING"|"CREATING"|"UPDATING"|"DELETING"|"FAILED",
  creationTime = as.POSIXct(
    "2015-01-01"
  ),
  currentVersion = "string",
  kafkaCluster = list(
    apacheKafkaCluster = list(
      bootstrapServers = "string",
      vpc = list(
        securityGroups = list(
          "string"
        ),
        subnets = list(
          "string"
        )
      )
    )
  ),
  kafkaClusterClientAuthentication = list(
    authenticationType = "NONE"|"IAM"
  ),
  kafkaClusterEncryptionInTransit = list(
    encryptionType = "PLAINTEXT"|"TLS"
  ),
  kafkaConnectVersion = "string",
  logDelivery = list(
    workerLogDelivery = list(
      cloudWatchLogs = list(
        enabled = TRUE|FALSE,
        logGroup = "string"
      ),
      firehose = list(
        deliveryStream = "string",
        enabled = TRUE|FALSE
      ),
      s3 = list(
        bucket = "string",
        enabled = TRUE|FALSE,
        prefix = "string"
      )
    )
  ),
  plugins = list(
    list(
      customPlugin = list(
        customPluginArn = "string",
        revision = 123
      )
    )
  ),
  serviceExecutionRoleArn = "string",
  stateDescription = list(
    code = "string",
    message = "string"
  ),
  workerConfiguration = list(
    revision = 123,
    workerConfigurationArn = "string"
  )
)

Request syntax

svc$describe_connector(
  connectorArn = "string"
)