instance_type_details

Creates, updates, deletes, gets or lists an instance_type_details resource.

Overview

Name	instance_type_details
Type	Resource
Id	aws.opensearch.instance_type_details

Fields

The following fields are returned by SELECT queries:

list_instance_type_details

Name	Datatype	Description
instance_type_details	array	Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.
next_token	string	When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_instance_type_details	select	engine_version, region	domainName, maxResults, nextToken, retrieveAZs, instanceType	Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

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
engine_version	string	The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
region	string	AWS region (default: us-east-1)
domainName	string	The name of the domain.
instanceType	string	An optional parameter that lists information for a given instance type.
maxResults	integer	An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
nextToken	string	If your initial ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.
retrieveAZs	boolean	An optional parameter that specifies the Availability Zones for the domain.

SELECT examples

list_instance_type_details

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

SELECT
instance_type_details,
next_token
FROM aws.opensearch.instance_type_details
WHERE engine_version = '{{ engine_version }}' -- required
AND region = '{{ region }}' -- required
AND domainName = '{{ domainName }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND retrieveAZs = '{{ retrieveAZs }}'
AND instanceType = '{{ instanceType }}'
;