Class: Aws::Kafka::Types::Cluster

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

Overview

Returns information about a cluster of either the provisioned or the serverless type.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_operation_arn ⇒ String

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

Returns:

  • (String) 


2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2554

class Cluster < Struct.new(
  :active_operation_arn,
  :cluster_type,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_version,
  :state,
  :state_info,
  :tags,
  :provisioned,
  :serverless)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_arn ⇒ String

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

Returns:

  • (String) 


2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2554

class Cluster < Struct.new(
  :active_operation_arn,
  :cluster_type,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_version,
  :state,
  :state_info,
  :tags,
  :provisioned,
  :serverless)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_name ⇒ String

The name of the cluster.

Returns:

  • (String) 


2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2554

class Cluster < Struct.new(
  :active_operation_arn,
  :cluster_type,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_version,
  :state,
  :state_info,
  :tags,
  :provisioned,
  :serverless)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_type ⇒ String

Cluster Type.

Returns:

  • (String) 


2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2554

class Cluster < Struct.new(
  :active_operation_arn,
  :cluster_type,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_version,
  :state,
  :state_info,
  :tags,
  :provisioned,
  :serverless)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The time when the cluster was created.

Returns:

  • (Time) 


2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2554

class Cluster < Struct.new(
  :active_operation_arn,
  :cluster_type,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_version,
  :state,
  :state_info,
  :tags,
  :provisioned,
  :serverless)
  SENSITIVE = []
  include Aws::Structure
end

#current_version ⇒ String

The current version of the MSK cluster.

Returns:

  • (String) 


2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2554

class Cluster < Struct.new(
  :active_operation_arn,
  :cluster_type,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_version,
  :state,
  :state_info,
  :tags,
  :provisioned,
  :serverless)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned ⇒ Types::Provisioned

Information about the provisioned cluster.

Returns:



2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2554

class Cluster < Struct.new(
  :active_operation_arn,
  :cluster_type,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_version,
  :state,
  :state_info,
  :tags,
  :provisioned,
  :serverless)
  SENSITIVE = []
  include Aws::Structure
end

#serverless ⇒ Types::Serverless

Information about the serverless cluster.

Returns:



2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2554

class Cluster < Struct.new(
  :active_operation_arn,
  :cluster_type,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_version,
  :state,
  :state_info,
  :tags,
  :provisioned,
  :serverless)
  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) 


2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2554

class Cluster < Struct.new(
  :active_operation_arn,
  :cluster_type,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_version,
  :state,
  :state_info,
  :tags,
  :provisioned,
  :serverless)
  SENSITIVE = []
  include Aws::Structure
end

#state_info ⇒ Types::StateInfo

State Info for the Amazon MSK cluster.

Returns:



2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2554

class Cluster < Struct.new(
  :active_operation_arn,
  :cluster_type,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_version,
  :state,
  :state_info,
  :tags,
  :provisioned,
  :serverless)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags attached to the cluster.

Returns:

  • (Hash<String,String>) 


2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
 
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2554

class Cluster < Struct.new(
  :active_operation_arn,
  :cluster_type,
  :cluster_arn,
  :cluster_name,
  :creation_time,
  :current_version,
  :state,
  :state_info,
  :tags,
  :provisioned,
  :serverless)
  SENSITIVE = []
  include Aws::Structure
end