CheckRemoteClusterConnectionInput is input datatype for checking a remote cluster connection. It's used by the checkRemoteClusterConnection() mutation field.

Table: CheckRemoteClusterConnectionInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 17, 2024
connectionIdstring  Short-TermThe unique identifier of the connection to check. Must be supplied if the token is not supplied.
multiClusterViewNamestring  Short-TermThe name of the multi-cluster view to which the connection belongs. Must be supplied if the token is not supplied.
publicUrlstringyes Short-TermThe public URL of the remote cluster to connect.
queryPrefixstring  Short-TermFilter query that restricts the data visible through this connection.
tags[ClusterConnectionInputTag]yes Short-TermAdditional tags that can be used to filter queries. See ClusterConnectionInputTag.
tokenstringyes Short-TermThe access token for the remote view to connect with. Can be omitted if checking an existing connection with no token change.