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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_operation_arn ⇒ String

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
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#broker_node_group_info ⇒ Types::BrokerNodeGroupInfo

Information about the brokers.

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#client_authentication ⇒ Types::ClientAuthentication

Includes all client authentication information.

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_arn ⇒ String

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
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_name ⇒ String

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
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

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
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#current_broker_software_info ⇒ Types::BrokerSoftwareInfo

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

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#current_version ⇒ String

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
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#customer_action_status ⇒ String

Determines if there is an action required from the customer.

Returns:

  • (String) 


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_info ⇒ Types::EncryptionInfo

Includes all encryption-related information.

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#enhanced_monitoring ⇒ String

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

[1]: docs.aws.amazon.com/msk/latest/developerguide/monitoring.html

Returns:

  • (String) 


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#logging_info ⇒ Types::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
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_broker_nodes ⇒ Integer

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
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#open_monitoring ⇒ Types::OpenMonitoring

Settings for open monitoring using Prometheus.

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#rebalancing ⇒ Types::Rebalancing

Contains information about intelligent rebalancing for new MSK Provisioned clusters with Express brokers. By default, intelligent rebalancing status is ACTIVE.

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

Returns:

  • (String) 


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#state_info ⇒ Types::StateInfo

Contains information about the state of the Amazon MSK cluster.

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#storage_mode ⇒ String

This controls storage mode for supported storage tiers.

Returns:

  • (String) 


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<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
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#zookeeper_connect_string ⇒ String

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
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end

#zookeeper_connect_string_tls ⇒ String

The connection string to use to connect to zookeeper cluster on Tls port.

Returns:

  • (String) 


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File '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,
  :state_info,
  :tags,
  :zookeeper_connect_string,
  :zookeeper_connect_string_tls,
  :storage_mode,
  :rebalancing,
  :customer_action_status)
  SENSITIVE = []
  include Aws::Structure
end