Class: Aws::OpenSearchService::Types::DescribeDomainHealthResponse

Inherits:

Struct

Object
Struct
Aws::OpenSearchService::Types::DescribeDomainHealthResponse

show all

Includes:: Structure

Defined in:: lib/aws-sdk-opensearchservice/types.rb

Overview

The result of a ‘DescribeDomainHealth` request. Contains health information for the requested domain.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#active_availability_zone_count ⇒ String

The number of active Availability Zones configured for the domain.
#availability_zone_count ⇒ String

The number of Availability Zones configured for the domain.
#cluster_health ⇒ String

The current health status of your cluster.
#data_node_count ⇒ String

The number of data nodes configured for the domain.
#dedicated_master ⇒ Boolean

A boolean that indicates if dedicated master nodes are activated for the domain.
#domain_state ⇒ String

The current state of the domain.
#environment_information ⇒ Array<Types::EnvironmentInfo>

A list of ‘EnvironmentInfo` for the domain.
#master_eligible_node_count ⇒ String

The number of nodes that can be elected as a master node.
#master_node ⇒ String

Indicates whether the domain has an elected master node.
#stand_by_availability_zone_count ⇒ String

The number of standby Availability Zones configured for the domain.
#total_shards ⇒ String

The total number of primary and replica shards for the domain.
#total_un_assigned_shards ⇒ String

The total number of primary and replica shards not allocated to any of the nodes for the cluster.
#warm_node_count ⇒ String

The number of warm nodes configured for the domain.

Instance Attribute Details

#active_availability_zone_count ⇒ `String`

The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return ‘NotAvailable`.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 2130

class DescribeDomainHealthResponse < Struct.new(
  :domain_state,
  :availability_zone_count,
  :active_availability_zone_count,
  :stand_by_availability_zone_count,
  :data_node_count,
  :dedicated_master,
  :master_eligible_node_count,
  :warm_node_count,
  :master_node,
  :cluster_health,
  :total_shards,
  :total_un_assigned_shards,
  :environment_information)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_count ⇒ `String`

The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return ‘NotAvailable`.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 2130

class DescribeDomainHealthResponse < Struct.new(
  :domain_state,
  :availability_zone_count,
  :active_availability_zone_count,
  :stand_by_availability_zone_count,
  :data_node_count,
  :dedicated_master,
  :master_eligible_node_count,
  :warm_node_count,
  :master_node,
  :cluster_health,
  :total_shards,
  :total_un_assigned_shards,
  :environment_information)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_health ⇒ `String`

The current health status of your cluster.

‘Red` - At least one primary shard is not allocated to any node.
‘Yellow` - All primary shards are allocated to nodes, but some replicas aren’t.
‘Green` - All primary shards and their replicas are allocated to nodes.
‘NotAvailable` - Unable to retrieve cluster health.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 2130

class DescribeDomainHealthResponse < Struct.new(
  :domain_state,
  :availability_zone_count,
  :active_availability_zone_count,
  :stand_by_availability_zone_count,
  :data_node_count,
  :dedicated_master,
  :master_eligible_node_count,
  :warm_node_count,
  :master_node,
  :cluster_health,
  :total_shards,
  :total_un_assigned_shards,
  :environment_information)
  SENSITIVE = []
  include Aws::Structure
end

#data_node_count ⇒ `String`

The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return ‘NotAvailable`.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 2130

class DescribeDomainHealthResponse < Struct.new(
  :domain_state,
  :availability_zone_count,
  :active_availability_zone_count,
  :stand_by_availability_zone_count,
  :data_node_count,
  :dedicated_master,
  :master_eligible_node_count,
  :warm_node_count,
  :master_node,
  :cluster_health,
  :total_shards,
  :total_un_assigned_shards,
  :environment_information)
  SENSITIVE = []
  include Aws::Structure
end

#dedicated_master ⇒ `Boolean`

A boolean that indicates if dedicated master nodes are activated for the domain.

Returns:

(Boolean)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 2130

class DescribeDomainHealthResponse < Struct.new(
  :domain_state,
  :availability_zone_count,
  :active_availability_zone_count,
  :stand_by_availability_zone_count,
  :data_node_count,
  :dedicated_master,
  :master_eligible_node_count,
  :warm_node_count,
  :master_node,
  :cluster_health,
  :total_shards,
  :total_un_assigned_shards,
  :environment_information)
  SENSITIVE = []
  include Aws::Structure
end

#domain_state ⇒ `String`

The current state of the domain.

‘Processing` - The domain has updates in progress.
‘Active` - Requested changes have been processed and deployed to the domain.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 2130

class DescribeDomainHealthResponse < Struct.new(
  :domain_state,
  :availability_zone_count,
  :active_availability_zone_count,
  :stand_by_availability_zone_count,
  :data_node_count,
  :dedicated_master,
  :master_eligible_node_count,
  :warm_node_count,
  :master_node,
  :cluster_health,
  :total_shards,
  :total_un_assigned_shards,
  :environment_information)
  SENSITIVE = []
  include Aws::Structure
end

#environment_information ⇒ `Array<Types::EnvironmentInfo>`

A list of ‘EnvironmentInfo` for the domain.

Returns:

(Array<Types::EnvironmentInfo>)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 2130

class DescribeDomainHealthResponse < Struct.new(
  :domain_state,
  :availability_zone_count,
  :active_availability_zone_count,
  :stand_by_availability_zone_count,
  :data_node_count,
  :dedicated_master,
  :master_eligible_node_count,
  :warm_node_count,
  :master_node,
  :cluster_health,
  :total_shards,
  :total_un_assigned_shards,
  :environment_information)
  SENSITIVE = []
  include Aws::Structure
end

#master_eligible_node_count ⇒ `String`

The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return ‘NotAvailable`.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 2130

class DescribeDomainHealthResponse < Struct.new(
  :domain_state,
  :availability_zone_count,
  :active_availability_zone_count,
  :stand_by_availability_zone_count,
  :data_node_count,
  :dedicated_master,
  :master_eligible_node_count,
  :warm_node_count,
  :master_node,
  :cluster_health,
  :total_shards,
  :total_un_assigned_shards,
  :environment_information)
  SENSITIVE = []
  include Aws::Structure
end

#master_node ⇒ `String`

Indicates whether the domain has an elected master node.

Available - The domain has an elected master node.
UnAvailable - The master node hasn’t yet been elected, and a quorum to elect a new master node hasn’t been reached.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 2130

class DescribeDomainHealthResponse < Struct.new(
  :domain_state,
  :availability_zone_count,
  :active_availability_zone_count,
  :stand_by_availability_zone_count,
  :data_node_count,
  :dedicated_master,
  :master_eligible_node_count,
  :warm_node_count,
  :master_node,
  :cluster_health,
  :total_shards,
  :total_un_assigned_shards,
  :environment_information)
  SENSITIVE = []
  include Aws::Structure
end

#stand_by_availability_zone_count ⇒ `String`

The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return ‘NotAvailable`.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 2130

class DescribeDomainHealthResponse < Struct.new(
  :domain_state,
  :availability_zone_count,
  :active_availability_zone_count,
  :stand_by_availability_zone_count,
  :data_node_count,
  :dedicated_master,
  :master_eligible_node_count,
  :warm_node_count,
  :master_node,
  :cluster_health,
  :total_shards,
  :total_un_assigned_shards,
  :environment_information)
  SENSITIVE = []
  include Aws::Structure
end

#total_shards ⇒ `String`

The total number of primary and replica shards for the domain.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 2130

class DescribeDomainHealthResponse < Struct.new(
  :domain_state,
  :availability_zone_count,
  :active_availability_zone_count,
  :stand_by_availability_zone_count,
  :data_node_count,
  :dedicated_master,
  :master_eligible_node_count,
  :warm_node_count,
  :master_node,
  :cluster_health,
  :total_shards,
  :total_un_assigned_shards,
  :environment_information)
  SENSITIVE = []
  include Aws::Structure
end

#total_un_assigned_shards ⇒ `String`

The total number of primary and replica shards not allocated to any of the nodes for the cluster.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 2130

class DescribeDomainHealthResponse < Struct.new(
  :domain_state,
  :availability_zone_count,
  :active_availability_zone_count,
  :stand_by_availability_zone_count,
  :data_node_count,
  :dedicated_master,
  :master_eligible_node_count,
  :warm_node_count,
  :master_node,
  :cluster_health,
  :total_shards,
  :total_un_assigned_shards,
  :environment_information)
  SENSITIVE = []
  include Aws::Structure
end

#warm_node_count ⇒ `String`

The number of warm nodes configured for the domain.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 2130

class DescribeDomainHealthResponse < Struct.new(
  :domain_state,
  :availability_zone_count,
  :active_availability_zone_count,
  :stand_by_availability_zone_count,
  :data_node_count,
  :dedicated_master,
  :master_eligible_node_count,
  :warm_node_count,
  :master_node,
  :cluster_health,
  :total_shards,
  :total_un_assigned_shards,
  :environment_information)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::OpenSearchService::Types::DescribeDomainHealthResponse

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#active_availability_zone_count ⇒ String

#availability_zone_count ⇒ String

#cluster_health ⇒ String

#data_node_count ⇒ String

#dedicated_master ⇒ Boolean

#domain_state ⇒ String

#environment_information ⇒ Array<Types::EnvironmentInfo>

#master_eligible_node_count ⇒ String

#master_node ⇒ String

#stand_by_availability_zone_count ⇒ String

#total_shards ⇒ String

#total_un_assigned_shards ⇒ String

#warm_node_count ⇒ String

#active_availability_zone_count ⇒ `String`

#availability_zone_count ⇒ `String`

#cluster_health ⇒ `String`

#data_node_count ⇒ `String`

#dedicated_master ⇒ `Boolean`

#domain_state ⇒ `String`

#environment_information ⇒ `Array<Types::EnvironmentInfo>`

#master_eligible_node_count ⇒ `String`

#master_node ⇒ `String`

#stand_by_availability_zone_count ⇒ `String`

#total_shards ⇒ `String`

#total_un_assigned_shards ⇒ `String`

#warm_node_count ⇒ `String`