elasticsearch_instance_type_limits

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

Overview

Name	elasticsearch_instance_type_limits
Type	Resource
Id	aws.es.elasticsearch_instance_type_limits

Fields

The following fields are returned by SELECT queries:

describe_elasticsearch_instance_type_limits

Name	Datatype	Description
limits_by_role	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_elasticsearch_instance_type_limits	select	instance_type, elasticsearch_version, region	domainName	Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.

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 Limits are needed.
instance_type	string	The instance type for an Elasticsearch cluster for which Elasticsearch Limits 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 Elasticsearch Limits for existing domain.

SELECT examples

describe_elasticsearch_instance_type_limits

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.

SELECT
limits_by_role
FROM aws.es.elasticsearch_instance_type_limits
WHERE instance_type = '{{ instance_type }}' -- required
AND elasticsearch_version = '{{ elasticsearch_version }}' -- required
AND region = '{{ region }}' -- required
AND domainName = '{{ domainName }}'
;