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

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

Overview

Returns information about a cluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_operation_arnString

Arn of active cluster operation.

Returns:

  • (String)


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#broker_node_group_infoTypes::BrokerNodeGroupInfo

Information about the broker nodes.



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#client_authenticationTypes::ClientAuthentication

Includes all client authentication information.



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_arnString

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

Returns:

  • (String)


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_nameString

The name of the cluster.

Returns:

  • (String)


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

The time when the cluster was created.

Returns:

  • (Time)


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#current_broker_software_infoTypes::BrokerSoftwareInfo

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



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#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)


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_infoTypes::EncryptionInfo

Includes all encryption-related information.



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#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)


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#logging_infoTypes::LoggingInfo

You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_broker_nodesInteger

The number of broker nodes in the cluster.

Returns:

  • (Integer)


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#open_monitoringTypes::OpenMonitoring

Settings for open monitoring using Prometheus.



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

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

Returns:

  • (String)


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

Tags attached to the cluster.

Returns:

  • (Hash<String,String>)


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end

#zookeeper_connect_stringString

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

Returns:

  • (String)


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 419

class ClusterInfo < Struct.new(
  :active_operation_arn,
  :broker_node_group_info,
  :client_authentication,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_broker_software_info,
  :logging_info,
  :current_version,
  :encryption_info,
  :enhanced_monitoring,
  :number_of_broker_nodes,
  :open_monitoring,
  :state,
  :tags,
  :zookeeper_connect_string)
  SENSITIVE = []
  include Aws::Structure
end