OpenSearch Service Domain

Docs > DDSQL Reference > Data Directory > OpenSearch Service Domain

An OpenSearch Service Domain in AWS is a managed search and analytics cluster that hosts OpenSearch or legacy Elasticsearch engines. It provides scalable indexing, search, and visualization capabilities without the need to manage infrastructure. Domains can be configured with different instance types, storage options, and security settings, and they integrate with AWS services for monitoring, access control, and data ingestion.

aws.opensearch_domain

Fields

ID	Type	Data Type	Description
_key	core	string
access_policies	core	string	Identity and Access Management (IAM) policy document specifying the access policies for the domain.
account_id	core	string
advanced_options	core	hstore	Key-value pairs that specify advanced configuration options.
advanced_security_options	core	json	Settings for fine-grained access control.
arn	core	string	The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.
auto_tune_options	core	json	Auto-Tune settings for the domain.
change_progress_details	core	json	Information about a configuration change happening on the domain.
cluster_config	core	json	Container for the cluster configuration of the domain.
cognito_options	core	json	Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
created	core	bool	Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
deleted	core	bool	Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.
domain_endpoint_options	core	json	Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
domain_endpoint_v2_hosted_zone_id	core	string	The dual stack hosted zone ID for the domain.
domain_id	core	string	Unique identifier for the domain.
domain_name	core	string	Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
domain_processing_status	core	string	The status of any changes that are currently in progress for the domain.
ebs_options	core	json	Container for EBS-based storage settings for the domain.
encryption_at_rest_options	core	json	Encryption at rest settings for the domain.
endpoint	core	string	Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
endpoint_v2	core	string	If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.
endpoints	core	hstore	The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example: IPv4 IP addresses - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' Dual stack IP addresses - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'
engine_version	core	string	Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.
ip_address_type	core	string	The type of IP addresses supported by the endpoint for the domain.
log_publishing_options	core	string	Log publishing options for the domain.
modifying_properties	core	json	Information about the domain properties that are currently being modified.
node_to_node_encryption_options	core	json	Whether node-to-node encryption is enabled or disabled.
off_peak_window_options	core	json	Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.
processing	core	bool	The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
service_software_options	core	json	The current status of the domain's service software.
snapshot_options	core	json	DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
software_update_options	core	json	Service software update options for the domain.
tags	core	hstore
upgrade_processing	core	bool	The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.
vpc_options	core	json	The VPC configuration for the domain.