Elasticsearch Domain

This table represents the Elasticsearch Domain resource from Amazon Web Services.

aws.elasticsearch_domain

Fields

TitleIDTypeData TypeDescription
_keycorestring
access_policiescorestringIAM access policy as a JSON-formatted string.
account_idcorestring
advanced_optionscorehstoreSpecifies the status of the <code>AdvancedOptions</code>
advanced_security_optionscorejsonThe current status of the Elasticsearch domain's advanced security options.
arncorestringThe Amazon resource name (ARN) of an Elasticsearch domain. See <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html" target="_blank">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information.
auto_tune_optionscorejsonThe current status of the Elasticsearch domain's Auto-Tune options.
change_progress_detailscorejsonSpecifies change details of the domain configuration change.
cognito_optionscorejsonThe <code>CognitoOptions</code> for the specified domain. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html" target="_blank">Amazon Cognito Authentication for Kibana</a>.
createdcoreboolThe domain creation status. <code>True</code> if the creation of an Elasticsearch domain is complete. <code>False</code> if domain creation is still in progress.
deletedcoreboolThe domain deletion status. <code>True</code> if a delete request has been received for the domain but resource cleanup is still in progress. <code>False</code> if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
domain_endpoint_optionscorejsonThe current status of the Elasticsearch domain's endpoint options.
domain_idcorestringThe unique identifier for the specified Elasticsearch domain.
domain_namecorestringThe 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_processing_statuscorestringThe status of any changes that are currently in progress for the domain.
ebs_optionscorejsonThe <code>EBSOptions</code> for the specified domain. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs" target="_blank">Configuring EBS-based Storage</a> for more information.
elasticsearch_cluster_configcorejsonThe type and number of instances in the domain cluster.
elasticsearch_versioncorestring
encryption_at_rest_optionscorejsonSpecifies the status of the <code>EncryptionAtRestOptions</code>.
endpointcorestringThe Elasticsearch domain endpoint that you use to submit index and search requests.
endpointscorehstoreMap containing the Elasticsearch domain endpoints used to submit index and search requests. Example <code>key, value</code>: <code>'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'</code>.
log_publishing_optionscorestringLog publishing options for the given domain.
modifying_propertiescorejsonInformation about the domain properties that are currently being modified.
node_to_node_encryption_optionscorejsonSpecifies the status of the <code>NodeToNodeEncryptionOptions</code>.
policiescorejson
processingcoreboolThe status of the Elasticsearch domain configuration. <code>True</code> if Amazon Elasticsearch Service is processing configuration changes. <code>False</code> if the configuration is active.
service_software_optionscorejsonThe current status of the Elasticsearch domain's service software.
snapshot_optionscorejsonSpecifies the status of the <code>SnapshotOptions</code>
tagscorehstore
upgrade_processingcoreboolThe status of an Elasticsearch domain version upgrade. <code>True</code> if Amazon Elasticsearch Service is undergoing a version upgrade. <code>False</code> if the configuration is active.
vpc_optionscorejsonThe <code>VPCOptions</code> for the specified domain. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html" target="_blank">VPC Endpoints for Amazon Elasticsearch Service Domains</a>.