domain_healths

Creates, updates, deletes, gets or lists a domain_healths resource.

Overview

Name	domain_healths
Type	Resource
Id	aws.opensearch.domain_healths

Fields

The following fields are returned by SELECT queries:

describe_domain_health

Name	Datatype	Description
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. (pattern: <code>^((\d+)|(NotAvailable))$</code>)
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. (pattern: <code>^((\d+)|(NotAvailable))$</code>)
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. (Red, Yellow, Green, NotAvailable)
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. (pattern: <code>^((\d+)|(NotAvailable))$</code>)
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. Processing - The domain has updates in progress. Active - Requested changes have been processed and deployed to the domain. (Active, Processing, NotAvailable)
environment_information	array	A list of EnvironmentInfo for the domain.
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. (pattern: <code>^((\d+)|(NotAvailable))$</code>)
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. (Available, UnAvailable)
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. (pattern: <code>^((\d+)|(NotAvailable))$</code>)
total_shards	string	The total number of primary and replica shards for the domain. (pattern: <code>^((\d+)|(NotAvailable))$</code>)
total_un_assigned_shards	string	The total number of primary and replica shards not allocated to any of the nodes for the cluster. (pattern: <code>^((\d+)|(NotAvailable))$</code>)
warm_node_count	string	The number of warm nodes configured for the domain. (pattern: <code>^((\d+)|(NotAvailable))$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_domain_health	select	domain_name, region		Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_name	string	The name of the domain.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_domain_health

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

SELECT
active_availability_zone_count,
availability_zone_count,
cluster_health,
data_node_count,
dedicated_master,
domain_state,
environment_information,
master_eligible_node_count,
master_node,
stand_by_availability_zone_count,
total_shards,
total_un_assigned_shards,
warm_node_count
FROM aws.opensearch.domain_healths
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
;