Skip to content

aws.es.describe_elasticsearch_domains

Example SQL Queries

SELECT * FROM
aws.es.describe_elasticsearch_domains
WHERE
"domain_names" = 'VALUE';

Description

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

Table Definition

Column NameColumn Data Type
domain_names Required Input Column

The Elasticsearch domains for which you want information.

VARCHAR[]
Show child fields
domain_names[]
_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
domain_status_list

The status of the domains requested in the DescribeElasticsearchDomains request.

STRUCT(
"domain_id" VARCHAR,
"domain_name" VARCHAR,
"arn" VARCHAR,
"created" BOOLEAN,
"deleted" BOOLEAN,
"endpoint" VARCHAR,
"endpoints" MAP(VARCHAR, VARCHAR),
"processing" BOOLEAN,
"upgrade_processing" BOOLEAN,
"elasticsearch_version" VARCHAR,
"elasticsearch_cluster_config" STRUCT(
"instance_type" VARCHAR,
"instance_count" BIGINT,
"dedicated_master_enabled" BOOLEAN,
"zone_awareness_enabled" BOOLEAN,
"zone_awareness_config" STRUCT(
"availability_zone_count" BIGINT
),
"dedicated_master_type" VARCHAR,
"dedicated_master_count" BIGINT,
"warm_enabled" BOOLEAN,
"warm_type" VARCHAR,
"warm_count" BIGINT,
"cold_storage_options" STRUCT(
"enabled" BOOLEAN
)
),
"ebs_options" STRUCT(
"ebs_enabled" BOOLEAN,
"volume_type" VARCHAR,
"volume_size" BIGINT,
"iops" BIGINT,
"throughput" BIGINT
),
"access_policies" VARCHAR,
"snapshot_options" STRUCT(
"automated_snapshot_start_hour" BIGINT
),
"vpc_options" STRUCT(
"vpc_id" VARCHAR,
"subnet_ids" VARCHAR[],
"availability_zones" VARCHAR[],
"security_group_ids" VARCHAR[]
),
"cognito_options" STRUCT(
"enabled" BOOLEAN,
"user_pool_id" VARCHAR,
"identity_pool_id" VARCHAR,
"role_arn" VARCHAR
),
"encryption_at_rest_options" STRUCT(
"enabled" BOOLEAN,
"kms_key_id" VARCHAR
),
"node_to_node_encryption_options" STRUCT(
"enabled" BOOLEAN
),
"advanced_options" MAP(VARCHAR, VARCHAR),
"log_publishing_options" MAP(VARCHAR, STRUCT(
"cloud_watch_logs_log_group_arn" VARCHAR,
"enabled" BOOLEAN
)),
"service_software_options" STRUCT(
"current_version" VARCHAR,
"new_version" VARCHAR,
"update_available" BOOLEAN,
"cancellable" BOOLEAN,
"update_status" VARCHAR,
"description" VARCHAR,
"automated_update_date" TIMESTAMP_S,
"optional_deployment" BOOLEAN
),
"domain_endpoint_options" STRUCT(
"enforce_https" BOOLEAN,
"tls_security_policy" VARCHAR,
"custom_endpoint_enabled" BOOLEAN,
"custom_endpoint" VARCHAR,
"custom_endpoint_certificate_arn" VARCHAR
),
"advanced_security_options" STRUCT(
"enabled" BOOLEAN,
"internal_user_database_enabled" BOOLEAN,
"saml_options" STRUCT(
"enabled" BOOLEAN,
"idp" STRUCT(
"metadata_content" VARCHAR,
"entity_id" VARCHAR
),
"subject_key" VARCHAR,
"roles_key" VARCHAR,
"session_timeout_minutes" BIGINT
),
"anonymous_auth_disable_date" TIMESTAMP_S,
"anonymous_auth_enabled" BOOLEAN
),
"auto_tune_options" STRUCT(
"state" VARCHAR,
"error_message" VARCHAR
),
"change_progress_details" STRUCT(
"change_id" VARCHAR,
"message" VARCHAR,
"config_change_status" VARCHAR,
"start_time" TIMESTAMP_S,
"last_updated_time" TIMESTAMP_S,
"initiated_by" VARCHAR
),
"domain_processing_status" VARCHAR,
"modifying_properties" STRUCT(
"name" VARCHAR,
"active_value" VARCHAR,
"pending_value" VARCHAR,
"value_type" VARCHAR
)[]
)[]
Show child fields
domain_status_list[]
Show child fields
domain_status_list[].access_policies

IAM access policy as a JSON-formatted string.

domain_status_list[].advanced_options

Specifies the status of the AdvancedOptions

domain_status_list[].advanced_security_options

The current status of the Elasticsearch domain's advanced security options.

Show child fields
domain_status_list[].advanced_security_options.anonymous_auth_disable_date

Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.

domain_status_list[].advanced_security_options.anonymous_auth_enabled

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

domain_status_list[].advanced_security_options.enabled

True if advanced security is enabled.

domain_status_list[].advanced_security_options.internal_user_database_enabled

True if the internal user database is enabled.

domain_status_list[].advanced_security_options.saml_options

Describes the SAML application configured for a domain.

Show child fields
domain_status_list[].advanced_security_options.saml_options.enabled

True if SAML is enabled.

domain_status_list[].advanced_security_options.saml_options.idp

Describes the SAML Identity Provider's information.

Show child fields
domain_status_list[].advanced_security_options.saml_options.idp.entity_id

The unique Entity ID of the application in SAML Identity Provider.

domain_status_list[].advanced_security_options.saml_options.idp.metadata_content

The Metadata of the SAML application in xml format.

domain_status_list[].advanced_security_options.saml_options.roles_key

The key used for matching the SAML Roles attribute.

domain_status_list[].advanced_security_options.saml_options.session_timeout_minutes

The duration, in minutes, after which a user session becomes inactive.

domain_status_list[].advanced_security_options.saml_options.subject_key

The key used for matching the SAML Subject attribute.

domain_status_list[].arn

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

domain_status_list[].auto_tune_options

The current status of the Elasticsearch domain's Auto-Tune options.

Show child fields
domain_status_list[].auto_tune_options.error_message

Specifies the error message while enabling or disabling the Auto-Tune.

domain_status_list[].auto_tune_options.state

Specifies the AutoTuneState for the Elasticsearch domain.

domain_status_list[].change_progress_details

Specifies change details of the domain configuration change.

Show child fields
domain_status_list[].change_progress_details.change_id

The unique change identifier associated with a specific domain configuration change.

domain_status_list[].change_progress_details.config_change_status

The current status of the configuration change.

domain_status_list[].change_progress_details.initiated_by

The IAM principal who initiated the configuration change.

domain_status_list[].change_progress_details.last_updated_time

The last time that the configuration change was updated.

domain_status_list[].change_progress_details.message

Contains an optional message associated with the domain configuration change.

domain_status_list[].change_progress_details.start_time

The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

domain_status_list[].cognito_options

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

Show child fields
domain_status_list[].cognito_options.enabled

Specifies the option to enable Cognito for Kibana authentication.

domain_status_list[].cognito_options.identity_pool_id

Specifies the Cognito identity pool ID for Kibana authentication.

domain_status_list[].cognito_options.role_arn

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

domain_status_list[].cognito_options.user_pool_id

Specifies the Cognito user pool ID for Kibana authentication.

domain_status_list[].created

The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

domain_status_list[].deleted

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

domain_status_list[].domain_endpoint_options

The current status of the Elasticsearch domain's endpoint options.

Show child fields
domain_status_list[].domain_endpoint_options.custom_endpoint

Specify the fully qualified domain for your custom endpoint.

domain_status_list[].domain_endpoint_options.custom_endpoint_certificate_arn

Specify ACM certificate ARN for your custom endpoint.

domain_status_list[].domain_endpoint_options.custom_endpoint_enabled

Specify if custom endpoint should be enabled for the Elasticsearch domain.

domain_status_list[].domain_endpoint_options.enforce_https

Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

domain_status_list[].domain_endpoint_options.tls_security_policy

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
It can be one of the following values:

  • Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
  • Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
  • Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites
domain_status_list[].domain_id

The unique identifier for the specified Elasticsearch domain.

domain_status_list[].domain_name

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

domain_status_list[].domain_processing_status

The status of any changes that are currently in progress for the domain.

domain_status_list[].ebs_options

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

Show child fields
domain_status_list[].ebs_options.ebs_enabled

Specifies whether EBS-based storage is enabled.

domain_status_list[].ebs_options.iops

Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

domain_status_list[].ebs_options.throughput

Specifies the Throughput for GP3 EBS volume (SSD).

domain_status_list[].ebs_options.volume_size

Integer to specify the size of an EBS volume.

domain_status_list[].ebs_options.volume_type

Specifies the volume type for EBS-based storage.

domain_status_list[].elasticsearch_cluster_config

The type and number of instances in the domain cluster.

Show child fields
domain_status_list[].elasticsearch_cluster_config.cold_storage_options

Specifies the ColdStorageOptions config for Elasticsearch Domain

Show child fields
domain_status_list[].elasticsearch_cluster_config.cold_storage_options.enabled

Enable cold storage option. Accepted values true or false

domain_status_list[].elasticsearch_cluster_config.dedicated_master_count

Total number of dedicated master nodes, active and on standby, for the cluster.

domain_status_list[].elasticsearch_cluster_config.dedicated_master_enabled

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

domain_status_list[].elasticsearch_cluster_config.dedicated_master_type

The instance type for a dedicated master node.

domain_status_list[].elasticsearch_cluster_config.instance_count

The number of instances in the specified domain cluster.

domain_status_list[].elasticsearch_cluster_config.instance_type

The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.

domain_status_list[].elasticsearch_cluster_config.warm_count

The number of warm nodes in the cluster.

domain_status_list[].elasticsearch_cluster_config.warm_enabled

True to enable warm storage.

domain_status_list[].elasticsearch_cluster_config.warm_type

The instance type for the Elasticsearch cluster's warm nodes.

domain_status_list[].elasticsearch_cluster_config.zone_awareness_config

Specifies the zone awareness configuration for a domain when zone awareness is enabled.

Show child fields
domain_status_list[].elasticsearch_cluster_config.zone_awareness_config.availability_zone_count

An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled

domain_status_list[].elasticsearch_cluster_config.zone_awareness_enabled

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

domain_status_list[].elasticsearch_version
domain_status_list[].encryption_at_rest_options

Specifies the status of the EncryptionAtRestOptions.

Show child fields
domain_status_list[].encryption_at_rest_options.enabled

Specifies the option to enable Encryption At Rest.

domain_status_list[].encryption_at_rest_options.kms_key_id

Specifies the KMS Key ID for Encryption At Rest options.

domain_status_list[].endpoint

The Elasticsearch domain endpoint that you use to submit index and search requests.

domain_status_list[].endpoints

Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

domain_status_list[].log_publishing_options

Log publishing options for the given domain.

domain_status_list[].modifying_properties[]
Show child fields
domain_status_list[].modifying_properties[].active_value

The current value of the domain property that is being modified.

domain_status_list[].modifying_properties[].name

The name of the property that is currently being modified.

domain_status_list[].modifying_properties[].pending_value

The value that the property that is currently being modified will eventually have.

domain_status_list[].modifying_properties[].value_type

The type of value that is currently being modified. Properties can have two types:

  • PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".
  • STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".
domain_status_list[].node_to_node_encryption_options

Specifies the status of the NodeToNodeEncryptionOptions.

Show child fields
domain_status_list[].node_to_node_encryption_options.enabled

Specify true to enable node-to-node encryption.

domain_status_list[].processing

The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

domain_status_list[].service_software_options

The current status of the Elasticsearch domain's service software.

Show child fields
domain_status_list[].service_software_options.automated_update_date

Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

domain_status_list[].service_software_options.cancellable

True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.

domain_status_list[].service_software_options.current_version

The current service software version that is present on the domain.

domain_status_list[].service_software_options.description

The description of the UpdateStatus.

domain_status_list[].service_software_options.new_version

The new service software version if one is available.

domain_status_list[].service_software_options.optional_deployment

True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.

domain_status_list[].service_software_options.update_available

True if you are able to update you service software version. False if you are not able to update your service software version.

domain_status_list[].service_software_options.update_status

The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

domain_status_list[].snapshot_options

Specifies the status of the SnapshotOptions

Show child fields
domain_status_list[].snapshot_options.automated_snapshot_start_hour

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

domain_status_list[].upgrade_processing

The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

domain_status_list[].vpc_options

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

Show child fields
domain_status_list[].vpc_options.availability_zones[]
domain_status_list[].vpc_options.security_group_ids[]
domain_status_list[].vpc_options.subnet_ids[]
domain_status_list[].vpc_options.vpc_id

The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.