Describe Cluster V2

kafka_describe_cluster_v2

R Documentation

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request

Description

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

Usage

kafka_describe_cluster_v2(ClusterArn)

Arguments

ClusterArn

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

Value

A list with the following syntax:

list(
  ClusterInfo = list(
    ActiveOperationArn = "string",
    ClusterType = "PROVISIONED"|"SERVERLESS",
    ClusterArn = "string",
    ClusterName = "string",
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    CurrentVersion = "string",
    State = "ACTIVE"|"CREATING"|"DELETING"|"FAILED"|"HEALING"|"MAINTENANCE"|"REBOOTING_BROKER"|"UPDATING",
    StateInfo = list(
      Code = "string",
      Message = "string"
    ),
    Tags = list(
      "string"
    ),
    Provisioned = list(
      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"
        )
      ),
      CurrentBrokerSoftwareInfo = list(
        ConfigurationArn = "string",
        ConfigurationRevision = 123,
        KafkaVersion = "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
        )
      ),
      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,
      ZookeeperConnectString = "string",
      ZookeeperConnectStringTls = "string",
      StorageMode = "LOCAL"|"TIERED",
      CustomerActionStatus = "CRITICAL_ACTION_REQUIRED"|"ACTION_RECOMMENDED"|"NONE"
    ),
    Serverless = list(
      VpcConfigs = list(
        list(
          SubnetIds = list(
            "string"
          ),
          SecurityGroupIds = list(
            "string"
          )
        )
      ),
      ClientAuthentication = list(
        Sasl = list(
          Iam = list(
            Enabled = TRUE|FALSE
          )
        )
      )
    )
  )
)

Request syntax

svc$describe_cluster_v2(
  ClusterArn = "string"
)