Couchbase · Schema

RemoteClusterReference

Remote cluster reference for XDCR

AnalyticsApp ServicesBackupCapellaCloudDatabaseDBaaSEventingFull-Text SearchGatewayJSONMobileNoSQLReplicationSQL++SyncVector SearchXDCR

Properties

Name	Type	Description
name	string	Name of the remote cluster reference
uuid	string	UUID of the remote cluster
hostname	string	Hostname and port of the remote cluster
username	string	Administrator username for the remote cluster
uri	string	URI for accessing this cluster reference
deleted	boolean	Whether the reference is marked for deletion
demandEncryption	boolean	Whether encryption is required
encryptionType	string	Type of encryption used

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RemoteClusterReference",
  "title": "RemoteClusterReference",
  "type": "object",
  "description": "Remote cluster reference for XDCR",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the remote cluster reference"
    },
    "uuid": {
      "type": "string",
      "description": "UUID of the remote cluster"
    },
    "hostname": {
      "type": "string",
      "description": "Hostname and port of the remote cluster"
    },
    "username": {
      "type": "string",
      "description": "Administrator username for the remote cluster"
    },
    "uri": {
      "type": "string",
      "description": "URI for accessing this cluster reference"
    },
    "deleted": {
      "type": "boolean",
      "description": "Whether the reference is marked for deletion"
    },
    "demandEncryption": {
      "type": "boolean",
      "description": "Whether encryption is required"
    },
    "encryptionType": {
      "type": "string",
      "description": "Type of encryption used",
      "enum": [
        "none",
        "half",
        "full"
      ]
    }
  }
}