RemoteResourceRef

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

`RemoteResourceRef`

edit

The 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
}

« RemoteResourceInfo RemoteResources »