instance_type_limits

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

Overview

Name	instance_type_limits
Type	Resource
Id	aws.opensearch.instance_type_limits

Fields

The following fields are returned by SELECT queries:

describe_instance_type_limits

Name	Datatype	Description
limits_by_role	object	Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_instance_type_limits	select	instance_type, engine_version, region	domainName	Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

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	Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
instance_type	string	The OpenSearch Service instance type for which you need limit information.
region	string	AWS region (default: us-east-1)
domainName	string	The name of the domain. Only specify if you need the limits for an existing domain.

SELECT examples

describe_instance_type_limits

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

SELECT
limits_by_role
FROM aws.opensearch.instance_type_limits
WHERE instance_type = '{{ instance_type }}' -- required
AND engine_version = '{{ engine_version }}' -- required
AND region = '{{ region }}' -- required
AND domainName = '{{ domainName }}'
;