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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kafka/types.rb

Overview

Returns information about a cluster.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#broker_node_group_info ⇒ Types::BrokerNodeGroupInfo

Information about the broker nodes.

Returns:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/aws-sdk-kafka/types.rb', line 180

class ClusterInfo < Struct.new(
  :broker_node_group_info,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :state,
  :zookeeper_connect_string)
  include Aws::Structure
end

#cluster_arn ⇒ String

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

Returns:

  • (String) 


180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/aws-sdk-kafka/types.rb', line 180

class ClusterInfo < Struct.new(
  :broker_node_group_info,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :state,
  :zookeeper_connect_string)
  include Aws::Structure
end

#cluster_name ⇒ String

The name of the cluster.

Returns:

  • (String) 


180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/aws-sdk-kafka/types.rb', line 180

class ClusterInfo < Struct.new(
  :broker_node_group_info,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :state,
  :zookeeper_connect_string)
  include Aws::Structure
end

#creation_time ⇒ Time

The time when the cluster was created.

Returns:

  • (Time) 


180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/aws-sdk-kafka/types.rb', line 180

class ClusterInfo < Struct.new(
  :broker_node_group_info,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :state,
  :zookeeper_connect_string)
  include Aws::Structure
end

#current_broker_software_info ⇒ Types::BrokerSoftwareInfo

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

Returns:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/aws-sdk-kafka/types.rb', line 180

class ClusterInfo < Struct.new(
  :broker_node_group_info,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :state,
  :zookeeper_connect_string)
  include Aws::Structure
end

#current_version ⇒ String

The current version of the MSK cluster.

Returns:

  • (String) 


180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/aws-sdk-kafka/types.rb', line 180

class ClusterInfo < Struct.new(
  :broker_node_group_info,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :state,
  :zookeeper_connect_string)
  include Aws::Structure
end

#encryption_info ⇒ Types::EncryptionInfo

Includes all encryption-related information.

Returns:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/aws-sdk-kafka/types.rb', line 180

class ClusterInfo < Struct.new(
  :broker_node_group_info,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :state,
  :zookeeper_connect_string)
  include Aws::Structure
end

#enhanced_monitoring ⇒ String

Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.

Returns:

  • (String) 


180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/aws-sdk-kafka/types.rb', line 180

class ClusterInfo < Struct.new(
  :broker_node_group_info,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :state,
  :zookeeper_connect_string)
  include Aws::Structure
end

#number_of_broker_nodes ⇒ Integer

The number of Kafka broker nodes in the cluster.

Returns:

  • (Integer) 


180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/aws-sdk-kafka/types.rb', line 180

class ClusterInfo < Struct.new(
  :broker_node_group_info,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :state,
  :zookeeper_connect_string)
  include Aws::Structure
end

#state ⇒ String

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

Returns:

  • (String) 


180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/aws-sdk-kafka/types.rb', line 180

class ClusterInfo < Struct.new(
  :broker_node_group_info,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :state,
  :zookeeper_connect_string)
  include Aws::Structure
end

#zookeeper_connect_string ⇒ String

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

Returns:

  • (String) 


180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/aws-sdk-kafka/types.rb', line 180

class ClusterInfo < Struct.new(
  :broker_node_group_info,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :state,
  :zookeeper_connect_string)
  include Aws::Structure
end