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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_operation_arnString

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

Returns:

  • (String)


2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2046

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_arnString

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

Returns:

  • (String)


2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2046

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_nameString

The name of the cluster.

Returns:

  • (String)


2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2046

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_typeString

Cluster Type.

Returns:

  • (String)


2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2046

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_timeTime

The time when the cluster was created.

Returns:

  • (Time)


2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2046

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_versionString

The current version of the MSK cluster.

Returns:

  • (String)


2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2046

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

#provisionedTypes::Provisioned

Information about the provisioned cluster.

Returns:



2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2046

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

#serverlessTypes::Serverless

Information about the serverless cluster.

Returns:



2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2046

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

#stateString

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

Returns:

  • (String)


2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2046

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_infoTypes::StateInfo

State Info for the Amazon MSK cluster.

Returns:



2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2046

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

#tagsHash<String,String>

Tags attached to the cluster.

Returns:

  • (Hash<String,String>)


2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2046

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