elasticsearch_instance_types

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

Overview

Name	elasticsearch_instance_types
Type	Resource
Id	aws.es.elasticsearch_instance_types

Fields

The following fields are returned by SELECT queries:

list_elasticsearch_instance_types

Name	Datatype	Description
elasticsearch_instance_type	string	List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_elasticsearch_instance_types	select	elasticsearch_version, region	domainName, maxResults, nextToken	List all Elasticsearch instance types that are supported for given ElasticsearchVersion

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
elasticsearch_version	string	Version of Elasticsearch for which list of supported elasticsearch instance types are needed.
region	string	AWS region (default: us-east-1)
domainName	string	DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.
maxResults	integer	Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.
nextToken	string	NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

SELECT examples

list_elasticsearch_instance_types

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

SELECT
elasticsearch_instance_type
FROM aws.es.elasticsearch_instance_types
WHERE elasticsearch_version = '{{ elasticsearch_version }}' -- required
AND region = '{{ region }}' -- required
AND domainName = '{{ domainName }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;