List Clusters

kafka_list_clusters

R Documentation

Returns a list of all the MSK clusters in the current Region

Description

Returns a list of all the MSK clusters in the current Region.

Usage

kafka_list_clusters(ClusterNameFilter, MaxResults, NextToken)

Arguments

ClusterNameFilter

Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

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(
  ClusterInfoList = list(
    list(
      ActiveOperationArn = "string",
      BrokerNodeGroupInfo = list(
        BrokerAZDistribution = "DEFAULT",
        ClientSubnets = list(
          "string"
        ),
        InstanceType = "string",
        SecurityGroups = list(
          "string"
        ),
        StorageInfo = list(
          EbsStorageInfo = list(
            ProvisionedThroughput = list(
              Enabled = TRUE|FALSE,
              VolumeThroughput = 123
            ),
            VolumeSize = 123
          )
        ),
        ConnectivityInfo = list(
          PublicAccess = list(
            Type = "string"
          ),
          VpcConnectivity = list(
            ClientAuthentication = list(
              Sasl = list(
                Scram = list(
                  Enabled = TRUE|FALSE
                ),
                Iam = list(
                  Enabled = TRUE|FALSE
                )
              ),
              Tls = list(
                Enabled = TRUE|FALSE
              )
            )
          )
        ),
        ZoneIds = list(
          "string"
        )
      ),
      ClientAuthentication = list(
        Sasl = list(
          Scram = list(
            Enabled = TRUE|FALSE
          ),
          Iam = list(
            Enabled = TRUE|FALSE
          )
        ),
        Tls = list(
          CertificateAuthorityArnList = list(
            "string"
          ),
          Enabled = TRUE|FALSE
        ),
        Unauthenticated = list(
          Enabled = TRUE|FALSE
        )
      ),
      ClusterArn = "string",
      ClusterName = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      CurrentBrokerSoftwareInfo = list(
        ConfigurationArn = "string",
        ConfigurationRevision = 123,
        KafkaVersion = "string"
      ),
      CurrentVersion = "string",
      EncryptionInfo = list(
        EncryptionAtRest = list(
          DataVolumeKMSKeyId = "string"
        ),
        EncryptionInTransit = list(
          ClientBroker = "TLS"|"TLS_PLAINTEXT"|"PLAINTEXT",
          InCluster = TRUE|FALSE
        )
      ),
      EnhancedMonitoring = "DEFAULT"|"PER_BROKER"|"PER_TOPIC_PER_BROKER"|"PER_TOPIC_PER_PARTITION",
      OpenMonitoring = list(
        Prometheus = list(
          JmxExporter = list(
            EnabledInBroker = TRUE|FALSE
          ),
          NodeExporter = list(
            EnabledInBroker = TRUE|FALSE
          )
        )
      ),
      LoggingInfo = list(
        BrokerLogs = list(
          CloudWatchLogs = list(
            Enabled = TRUE|FALSE,
            LogGroup = "string"
          ),
          Firehose = list(
            DeliveryStream = "string",
            Enabled = TRUE|FALSE
          ),
          S3 = list(
            Bucket = "string",
            Enabled = TRUE|FALSE,
            Prefix = "string"
          )
        )
      ),
      NumberOfBrokerNodes = 123,
      State = "ACTIVE"|"CREATING"|"DELETING"|"FAILED"|"HEALING"|"MAINTENANCE"|"REBOOTING_BROKER"|"UPDATING",
      StateInfo = list(
        Code = "string",
        Message = "string"
      ),
      Tags = list(
        "string"
      ),
      ZookeeperConnectString = "string",
      ZookeeperConnectStringTls = "string",
      StorageMode = "LOCAL"|"TIERED",
      CustomerActionStatus = "CRITICAL_ACTION_REQUIRED"|"ACTION_RECOMMENDED"|"NONE"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_clusters(
  ClusterNameFilter = "string",
  MaxResults = 123,
  NextToken = "string"
)