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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opensearchservice/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

Instance Attribute Details

#active_availability_zone_countString

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)


2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2536

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_countString

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

Returns:

  • (String)


2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2536

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_healthString

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)


2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2536

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_countString

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

Returns:

  • (String)


2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2536

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_masterBoolean

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

Returns:

  • (Boolean)


2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2536

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_stateString

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)


2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2536

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_informationArray<Types::EnvironmentInfo>

A list of EnvironmentInfo for the domain.

Returns:



2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2536

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_countString

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)


2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2536

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_nodeString

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)


2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2536

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_countString

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)


2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2536

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_shardsString

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

Returns:

  • (String)


2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2536

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_shardsString

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

Returns:

  • (String)


2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2536

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_countString

The number of warm nodes configured for the domain.

Returns:

  • (String)


2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2536

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