You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Kafka::Types::ClusterInfo

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returns information about a cluster.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#active_operation_arnString

Arn of active cluster operation.

Returns:

  • (String)

    Arn of active cluster operation.

#broker_node_group_infoTypes::BrokerNodeGroupInfo

Information about the broker nodes.

Returns:

#client_authenticationTypes::ClientAuthentication

Includes all client authentication information.

Returns:

#cluster_arnString

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

Returns:

  • (String)

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

#cluster_nameString

The name of the cluster.

Returns:

  • (String)

    The name of the cluster.

#creation_timeTime

The time when the cluster was created.

Returns:

  • (Time)

    The time when the cluster was created.

#current_broker_software_infoTypes::BrokerSoftwareInfo

Information about the version of software currently deployed on the Kafka brokers in the cluster.

Returns:

  • (Types::BrokerSoftwareInfo)

    Information about the version of software currently deployed on the Kafka brokers in the cluster.

#current_versionString

The current version of the MSK cluster. Cluster versions aren\'t simple integers. You can obtain the current version by describing the cluster. An example version is KTVPDKIKX0DER.

Returns:

  • (String)

    The current version of the MSK cluster.

#encryption_infoTypes::EncryptionInfo

Includes all encryption-related information.

Returns:

#enhanced_monitoringString

Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.

Returns:

  • (String)

    Specifies which metrics are gathered for the MSK cluster.

#number_of_broker_nodesInteger

The number of broker nodes in the cluster.

Returns:

  • (Integer)

    The number of broker nodes in the cluster.

#stateString

The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

Possible values:

  • ACTIVE
  • CREATING
  • UPDATING
  • DELETING
  • FAILED

Returns:

  • (String)

    The state of the cluster.

#tagsHash<String,String>

Tags attached to the cluster.

Returns:

  • (Hash<String,String>)

    Tags attached to the cluster.

#zookeeper_connect_stringString

The connection string to use to connect to the Apache ZooKeeper cluster.

Returns:

  • (String)

    The connection string to use to connect to the Apache ZooKeeper cluster.