It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
RemoteResourceRef
editRemoteResourceRef
editThe Elasticsearch resource used as a Remote Cluster.
Properties
edit-
alias
(string
, required) - The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores
-
deployment_id
(string
, required) - The id of the deployment
-
elasticsearch_ref_id
(string
, required) - The locally-unique user-specified id of an Elasticsearch Resource
-
info
(RemoteResourceInfo
) - Information about a Remote Cluster.
-
skip_unavailable
(boolean
) - If true, skip this cluster during search if it is disconnected. Default: false
Example
edit{ "alias" : "string", "deployment_id" : "string", "elasticsearch_ref_id" : "string", "info" : { "compatible" : true, "connected" : true, "healthy" : true, "trusted" : true, "trusted_back" : true }, "skip_unavailable" : true }