domain_nodes

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

Overview

Name	domain_nodes
Type	Resource
Id	aws.opensearch.domain_nodes

Fields

The following fields are returned by SELECT queries:

describe_domain_nodes

Name	Datatype	Description
domain_nodes_status_list	array	Contains nodes information list DomainNodesStatusList with details about the all nodes on the requested domain.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_domain_nodes	select	domain_name, region		Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

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_nodes

Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

SELECT
domain_nodes_status_list
FROM aws.opensearch.domain_nodes
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
;