Skip to content
AWS for Query.Farm

aws.es.describe_elasticsearch_instance_type_limits

Example SQL Queries

SELECT * FROM
aws.es.describe_elasticsearch_instance_type_limits
WHERE
"instance_type" = 'VALUE'
AND "elasticsearch_version" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
elasticsearch_version Required Input Column

Version of Elasticsearch for which Limits are needed. 

VARCHAR
instance_type Required Input Column

The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed. 

VARCHAR
domain_name Input Column

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. 

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
limits_by_role

Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following:

  • data: If the given InstanceType is used as data node
  • master: If the given InstanceType is used as master node
  • ultra_warm: If the given InstanceType is used as warm node
MAP(VARCHAR, STRUCT(
        "storage_types" STRUCT(
            "storage_type_name" VARCHAR,
            "storage_sub_type_name" VARCHAR,
            "storage_type_limits" STRUCT(
                "limit_name" VARCHAR,
                "limit_values" VARCHAR[]
            )[]
        )[],
        "instance_limits" STRUCT(
            "instance_count_limits" STRUCT(
                "minimum_instance_count" BIGINT,
                "maximum_instance_count" BIGINT
            )
        ),
        "additional_limits" STRUCT(
            "limit_name" VARCHAR,
            "limit_values" VARCHAR[]
        )[]
    ))