List Nodes

kafka_list_nodes

R Documentation

Returns a list of the broker nodes in the cluster

Description

Returns a list of the broker nodes in the cluster.

Usage

kafka_list_nodes(ClusterArn, MaxResults, NextToken)

Arguments

ClusterArn

[required] The Amazon Resource Name (ARN) that uniquely identifies the cluster.

MaxResults

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

NextToken

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

Value

A list with the following syntax:

list(
  NextToken = "string",
  NodeInfoList = list(
    list(
      AddedToClusterTime = "string",
      BrokerNodeInfo = list(
        AttachedENIId = "string",
        BrokerId = 123.0,
        ClientSubnet = "string",
        ClientVpcIpAddress = "string",
        CurrentBrokerSoftwareInfo = list(
          ConfigurationArn = "string",
          ConfigurationRevision = 123,
          KafkaVersion = "string"
        ),
        Endpoints = list(
          "string"
        )
      ),
      ControllerNodeInfo = list(
        Endpoints = list(
          "string"
        )
      ),
      InstanceType = "string",
      NodeARN = "string",
      NodeType = "BROKER",
      ZookeeperNodeInfo = list(
        AttachedENIId = "string",
        ClientVpcIpAddress = "string",
        Endpoints = list(
          "string"
        ),
        ZookeeperId = 123.0,
        ZookeeperVersion = "string"
      )
    )
  )
)

Request syntax

svc$list_nodes(
  ClusterArn = "string",
  MaxResults = 123,
  NextToken = "string"
)