Connection Manager API, gRPC: ConnectionService.Update

Written by

Yandex Cloud

Updated at October 30, 2025

gRPC request
UpdateConnectionRequest
ConnectionParams
PostgreSQLConnection
PostgreSQLCluster
Host
TLSParams
TLSConfig
PostgreSQLAuth
UserPasswordAuth
Password
PasswordGenerationOptions
LockboxPasswordGenerationOptions
MySQLConnection
MySQLCluster
Host
MySQLAuth
MongoDBConnection
MongoDBCluster
Host
MongoDBAuth
ClickHouseConnection
ClickHouseCluster
Host
ShardGroup
ClickHouseAuth
KafkaConnection
KafkaCluster
Host
KafkaAuth
KafkaSaslSecurity
RedisConnection
RedisCluster
Host
RedisAuth
UserPasswordAuth
OpenSearchConnection
OpenSearchCluster
Host
OpenSearchAuth
TrinoConnection
TrinoCluster
Coordinator
TrinoAuth
ValkeyConnection
ValkeyCluster
Host
ValkeyAuth
UserPasswordAuth
GreenplumConnection
GreenplumCluster
Host
GreenplumAuth
StoreDocConnection
StoreDocCluster
Host
StoreDocAuth
operation.Operation
UpdateConnectionMetadata
Connection
ConnectionParams
PostgreSQLConnection
PostgreSQLCluster
Host
TLSParams
TLSConfig
PostgreSQLAuth
UserPasswordAuth
Password
PasswordGenerationOptions
LockboxPasswordGenerationOptions
MySQLConnection
MySQLCluster
Host
MySQLAuth
MongoDBConnection
MongoDBCluster
Host
MongoDBAuth
ClickHouseConnection
ClickHouseCluster
Host
ShardGroup
ClickHouseAuth
KafkaConnection
KafkaCluster
Host
KafkaAuth
KafkaSaslSecurity
RedisConnection
RedisCluster
Host
RedisAuth
UserPasswordAuth
OpenSearchConnection
OpenSearchCluster
Host
OpenSearchAuth
TrinoConnection
TrinoCluster
Coordinator
TrinoAuth
ValkeyConnection
ValkeyCluster
Host
ValkeyAuth
UserPasswordAuth
GreenplumConnection
GreenplumCluster
Host
GreenplumAuth
StoreDocConnection
StoreDocCluster
Host
StoreDocAuth
LockboxSecret

Updates specified connection.

gRPC request

rpc Update (UpdateConnectionRequest) returns (operation.Operation)

UpdateConnectionRequest

{
  "connection_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "params": {
    // Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`
    "postgresql": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "int64",
            "role": "Role",
            "replica_type": "ReplicaType",
            "health": "Health"
          }
        ],
        "tls_params": {
          // Includes only one of the fields `disabled`, `tls`
          "disabled": "google.protobuf.Empty",
          "tls": {
            "ca_certificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managed_cluster_id": "string",
      "auth": {
        // Includes only one of the fields `user_password`
        "user_password": {
          "user": "string",
          "password": {
            "raw": "string",
            "password_generation_options": {
              "cookie": "string",
              // Includes only one of the fields `lockbox_password_generation_options`
              "lockbox_password_generation_options": {
                "length": "int64",
                "include_uppercase": "google.protobuf.BoolValue",
                "include_lowercase": "google.protobuf.BoolValue",
                "include_digits": "google.protobuf.BoolValue",
                "include_punctuation": "google.protobuf.BoolValue",
                "included_punctuation": "string",
                "excluded_punctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockbox_secret_key`
            "lockbox_secret_key": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      },
      "databases": [
        "string"
      ]
    },
    "mysql": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "int64",
            "role": "Role",
            "health": "Health"
          }
        ],
        "tls_params": {
          // Includes only one of the fields `disabled`, `tls`
          "disabled": "google.protobuf.Empty",
          "tls": {
            "ca_certificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managed_cluster_id": "string",
      "auth": {
        // Includes only one of the fields `user_password`
        "user_password": {
          "user": "string",
          "password": {
            "raw": "string",
            "password_generation_options": {
              "cookie": "string",
              // Includes only one of the fields `lockbox_password_generation_options`
              "lockbox_password_generation_options": {
                "length": "int64",
                "include_uppercase": "google.protobuf.BoolValue",
                "include_lowercase": "google.protobuf.BoolValue",
                "include_digits": "google.protobuf.BoolValue",
                "include_punctuation": "google.protobuf.BoolValue",
                "included_punctuation": "string",
                "excluded_punctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockbox_secret_key`
            "lockbox_secret_key": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      },
      "databases": [
        "string"
      ]
    },
    "mongodb": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "int64",
            "role": "Role",
            "health": "Health",
            "type": "Type"
          }
        ],
        "tls_params": {
          // Includes only one of the fields `disabled`, `tls`
          "disabled": "google.protobuf.Empty",
          "tls": {
            "ca_certificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managed_cluster_id": "string",
      "auth": {
        // Includes only one of the fields `user_password`
        "user_password": {
          "user": "string",
          "password": {
            "raw": "string",
            "password_generation_options": {
              "cookie": "string",
              // Includes only one of the fields `lockbox_password_generation_options`
              "lockbox_password_generation_options": {
                "length": "int64",
                "include_uppercase": "google.protobuf.BoolValue",
                "include_lowercase": "google.protobuf.BoolValue",
                "include_digits": "google.protobuf.BoolValue",
                "include_punctuation": "google.protobuf.BoolValue",
                "included_punctuation": "string",
                "excluded_punctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockbox_secret_key`
            "lockbox_secret_key": "string"
            // end of the list of possible fields
          }
        },
        // end of the list of possible fields
        "auth_source": "string"
      },
      "databases": [
        "string"
      ]
    },
    "clickhouse": {
      "cluster": {
        "tls_params": {
          // Includes only one of the fields `disabled`, `tls`
          "disabled": "google.protobuf.Empty",
          "tls": {
            "ca_certificate": "string"
          }
          // end of the list of possible fields
        },
        "hosts": [
          {
            "host": "string",
            "http_port": "int64",
            "tcp_port": "int64",
            "shard_name": "string",
            "health": "Health"
          }
        ],
        "shard_groups": [
          {
            "name": "string",
            "shard_names": [
              "string"
            ]
          }
        ]
      },
      "managed_cluster_id": "string",
      "auth": {
        // Includes only one of the fields `user_password`
        "user_password": {
          "user": "string",
          "password": {
            "raw": "string",
            "password_generation_options": {
              "cookie": "string",
              // Includes only one of the fields `lockbox_password_generation_options`
              "lockbox_password_generation_options": {
                "length": "int64",
                "include_uppercase": "google.protobuf.BoolValue",
                "include_lowercase": "google.protobuf.BoolValue",
                "include_digits": "google.protobuf.BoolValue",
                "include_punctuation": "google.protobuf.BoolValue",
                "included_punctuation": "string",
                "excluded_punctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockbox_secret_key`
            "lockbox_secret_key": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      },
      "databases": [
        "string"
      ]
    },
    "kafka": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "int64",
            "health": "Health"
          }
        ],
        "tls_params": {
          // Includes only one of the fields `disabled`, `tls`
          "disabled": "google.protobuf.Empty",
          "tls": {
            "ca_certificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managed_cluster_id": "string",
      "auth": {
        // Includes only one of the fields `sasl`, `disabled`
        "sasl": {
          "user": "string",
          "password": {
            "raw": "string",
            "password_generation_options": {
              "cookie": "string",
              // Includes only one of the fields `lockbox_password_generation_options`
              "lockbox_password_generation_options": {
                "length": "int64",
                "include_uppercase": "google.protobuf.BoolValue",
                "include_lowercase": "google.protobuf.BoolValue",
                "include_digits": "google.protobuf.BoolValue",
                "include_punctuation": "google.protobuf.BoolValue",
                "included_punctuation": "string",
                "excluded_punctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockbox_secret_key`
            "lockbox_secret_key": "string"
            // end of the list of possible fields
          },
          "supported_mechanisms": [
            "Mechanism"
          ]
        },
        "disabled": "google.protobuf.Empty"
        // end of the list of possible fields
      }
    },
    "redis": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "int64",
            "role": "Role",
            "health": "Health",
            "shard_name": "string"
          }
        ],
        "sentinel_port": "int64",
        "tls_params": {
          // Includes only one of the fields `disabled`, `tls`
          "disabled": "google.protobuf.Empty",
          "tls": {
            "ca_certificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "auth": {
        // Includes only one of the fields `user_password`
        "user_password": {
          "user": "string",
          "password": {
            "raw": "string",
            "password_generation_options": {
              "cookie": "string",
              // Includes only one of the fields `lockbox_password_generation_options`
              "lockbox_password_generation_options": {
                "length": "int64",
                "include_uppercase": "google.protobuf.BoolValue",
                "include_lowercase": "google.protobuf.BoolValue",
                "include_digits": "google.protobuf.BoolValue",
                "include_punctuation": "google.protobuf.BoolValue",
                "included_punctuation": "string",
                "excluded_punctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockbox_secret_key`
            "lockbox_secret_key": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      },
      "databases": [
        "int64"
      ]
    },
    "opensearch": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "int64",
            "health": "Health",
            "roles": [
              "GroupRole"
            ]
          }
        ],
        "tls_params": {
          // Includes only one of the fields `disabled`, `tls`
          "disabled": "google.protobuf.Empty",
          "tls": {
            "ca_certificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managed_cluster_id": "string",
      "auth": {
        // Includes only one of the fields `user_password`
        "user_password": {
          "user": "string",
          "password": {
            "raw": "string",
            "password_generation_options": {
              "cookie": "string",
              // Includes only one of the fields `lockbox_password_generation_options`
              "lockbox_password_generation_options": {
                "length": "int64",
                "include_uppercase": "google.protobuf.BoolValue",
                "include_lowercase": "google.protobuf.BoolValue",
                "include_digits": "google.protobuf.BoolValue",
                "include_punctuation": "google.protobuf.BoolValue",
                "included_punctuation": "string",
                "excluded_punctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockbox_secret_key`
            "lockbox_secret_key": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      }
    },
    "trino": {
      "cluster": {
        "coordinator": {
          "host": "string",
          "port": "int64"
        },
        "tls_params": {
          // Includes only one of the fields `disabled`, `tls`
          "disabled": "google.protobuf.Empty",
          "tls": {
            "ca_certificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "auth": {
        // Includes only one of the fields `user_password`
        "user_password": {
          "user": "string",
          "password": {
            "raw": "string",
            "password_generation_options": {
              "cookie": "string",
              // Includes only one of the fields `lockbox_password_generation_options`
              "lockbox_password_generation_options": {
                "length": "int64",
                "include_uppercase": "google.protobuf.BoolValue",
                "include_lowercase": "google.protobuf.BoolValue",
                "include_digits": "google.protobuf.BoolValue",
                "include_punctuation": "google.protobuf.BoolValue",
                "included_punctuation": "string",
                "excluded_punctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockbox_secret_key`
            "lockbox_secret_key": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      }
    },
    "valkey": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "int64",
            "role": "Role",
            "health": "Health",
            "shard_name": "string"
          }
        ],
        "sentinel_port": "int64",
        "tls_params": {
          // Includes only one of the fields `disabled`, `tls`
          "disabled": "google.protobuf.Empty",
          "tls": {
            "ca_certificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managed_cluster_id": "string",
      "auth": {
        // Includes only one of the fields `user_password`
        "user_password": {
          "user": "string",
          "password": {
            "raw": "string",
            "password_generation_options": {
              "cookie": "string",
              // Includes only one of the fields `lockbox_password_generation_options`
              "lockbox_password_generation_options": {
                "length": "int64",
                "include_uppercase": "google.protobuf.BoolValue",
                "include_lowercase": "google.protobuf.BoolValue",
                "include_digits": "google.protobuf.BoolValue",
                "include_punctuation": "google.protobuf.BoolValue",
                "included_punctuation": "string",
                "excluded_punctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockbox_secret_key`
            "lockbox_secret_key": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      },
      "databases": [
        "int64"
      ]
    },
    "greenplum": {
      "cluster": {
        "coordinator_hosts": [
          {
            "host": "string",
            "port": "int64",
            "role": "Role",
            "health": "Health"
          }
        ],
        "tls_params": {
          // Includes only one of the fields `disabled`, `tls`
          "disabled": "google.protobuf.Empty",
          "tls": {
            "ca_certificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managed_cluster_id": "string",
      "auth": {
        // Includes only one of the fields `user_password`
        "user_password": {
          "user": "string",
          "password": {
            "raw": "string",
            "password_generation_options": {
              "cookie": "string",
              // Includes only one of the fields `lockbox_password_generation_options`
              "lockbox_password_generation_options": {
                "length": "int64",
                "include_uppercase": "google.protobuf.BoolValue",
                "include_lowercase": "google.protobuf.BoolValue",
                "include_digits": "google.protobuf.BoolValue",
                "include_punctuation": "google.protobuf.BoolValue",
                "included_punctuation": "string",
                "excluded_punctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockbox_secret_key`
            "lockbox_secret_key": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      },
      "databases": [
        "string"
      ]
    },
    "storedoc": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "int64",
            "role": "Role",
            "health": "Health",
            "type": "Type"
          }
        ],
        "tls_params": {
          // Includes only one of the fields `disabled`, `tls`
          "disabled": "google.protobuf.Empty",
          "tls": {
            "ca_certificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managed_cluster_id": "string",
      "auth": {
        // Includes only one of the fields `user_password`
        "user_password": {
          "user": "string",
          "password": {
            "raw": "string",
            "password_generation_options": {
              "cookie": "string",
              // Includes only one of the fields `lockbox_password_generation_options`
              "lockbox_password_generation_options": {
                "length": "int64",
                "include_uppercase": "google.protobuf.BoolValue",
                "include_lowercase": "google.protobuf.BoolValue",
                "include_digits": "google.protobuf.BoolValue",
                "include_punctuation": "google.protobuf.BoolValue",
                "included_punctuation": "string",
                "excluded_punctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockbox_secret_key`
            "lockbox_secret_key": "string"
            // end of the list of possible fields
          }
        },
        // end of the list of possible fields
        "auth_source": "string"
      },
      "databases": [
        "string"
      ]
    }
    // end of the list of possible fields
  }
}

Field	Description
connection_id	string
update_mask	google.protobuf.FieldMask
name	string
description	string
labels	object (map<string, string>)
params	ConnectionParams

ConnectionParams

Field	Description
postgresql	PostgreSQLConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
mysql	MySQLConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
mongodb	MongoDBConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
clickhouse	ClickHouseConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
kafka	KafkaConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
redis	RedisConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
opensearch	OpenSearchConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
trino	TrinoConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
valkey	ValkeyConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
greenplum	GreenplumConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
storedoc	StoreDocConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.

PostgreSQLConnection

Field	Description
cluster	PostgreSQLCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	PostgreSQLAuth
databases[]	string

PostgreSQLCluster

Field	Description
hosts[]	Host
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
role	enum Role `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
replica_type	enum ReplicaType `REPLICA_TYPE_UNSPECIFIED` `ASYNC` `SYNC` `QUORUM`
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `READONLY`

TLSParams

Field

Description

disabled

google.protobuf.Empty

Includes only one of the fields disabled, tls.

tls

TLSConfig

Includes only one of the fields disabled, tls.

TLSConfig

Field	Description
ca_certificate	string

PostgreSQLAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

UserPasswordAuth

Field	Description
user	string
password	Password

Password

Field	Description
raw	string When creating/updating Password, the field "raw" is mutually exclusive with "password_generation_options". In order to switch to the "raw" password you have to explicitly clear the "password_generation_options" field.
password_generation_options	PasswordGenerationOptions When creating/updating Password, the field "password_generation_options" is mutually exclusive with "raw". In order to switch to the "password_generation_options" you have to explicitly clear the "raw" field.
lockbox_secret_key	string Read-only. Do not fill this field in create/update requests. Includes only one of the fields `lockbox_secret_key`.

Cookie is an arbitrary non-sensitive string that is saved with the
password. When updating PasswordGenerationOptions, if the cookie passed
in the update request differs from the cookie in the current
PasswordGenerationOptions, the password will be re-generated. If the
same cookie is passed, the password will not change.

lockbox_password_generation_options

LockboxPasswordGenerationOptions

Includes only one of the fields lockbox_password_generation_options.

LockboxPasswordGenerationOptions

Field	Description
length	int64 password length; by default, a reasonable length will be decided
include_uppercase	google.protobuf.BoolValue whether at least one A..Z character is included in the password, true by default
include_lowercase	google.protobuf.BoolValue whether at least one a..z character is included in the password, true by default
include_digits	google.protobuf.BoolValue whether at least one 0..9 character is included in the password, true by default
include_punctuation	google.protobuf.BoolValue whether at least one punctuation character is included in the password, true by default punctuation characters by default: !"#$%&'()*+,-./:;<=>?@[]^_`{\|}~ to customize the punctuation characters, see included_punctuation and excluded_punctuation below
included_punctuation	string If include_punctuation is true, one of these two fields (not both) may be used optionally to customize the punctuation: a string of specific punctuation characters to use
excluded_punctuation	string a string of punctuation characters to exclude from the default

MySQLConnection

Field	Description
cluster	MySQLCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	MySQLAuth
databases[]	string

MySQLCluster

Field	Description
hosts[]	Host
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
role	enum Role `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `READONLY`

MySQLAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

MongoDBConnection

Field	Description
cluster	MongoDBCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	MongoDBAuth
databases[]	string

MongoDBCluster

Field	Description
hosts[]	Host
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
role	enum Role `ROLE_UNSPECIFIED` `PRIMARY` `SECONDARY`
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
type	enum Type `TYPE_UNSPECIFIED` `MONGOD` `MONGOS` `MONGOINFRA`

MongoDBAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

auth_source

string

ClickHouseConnection

Field	Description
cluster	ClickHouseCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	ClickHouseAuth
databases[]	string

ClickHouseCluster

Field	Description
tls_params	TLSParams
hosts[]	Host
shard_groups[]	ShardGroup

Host

Field	Description
host	string
http_port	int64 depends on tls params may vary as http or https
tcp_port	int64
shard_name	string
health	enum Health `HEALTH_UNKNOWN` `ALIVE` `DEAD` `DEGRADED`

ShardGroup

Field	Description
name	string
shard_names[]	string

ClickHouseAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

KafkaConnection

Field	Description
cluster	KafkaCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	KafkaAuth

KafkaCluster

Field	Description
hosts[]	Host
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
health	enum Health `HEALTH_UNSPECIFIED`: Host is in unknown state (we have no data) `ALIVE`: Host is alive and well (all services are alive) `DEAD`: Host is inoperable (it cannot perform any of its essential functions) `DEGRADED`: Host is partially alive (it can perform some of its essential functions)

KafkaAuth

Field

Description

sasl

KafkaSaslSecurity

Includes only one of the fields sasl, disabled.

disabled

google.protobuf.Empty

Includes only one of the fields sasl, disabled.

KafkaSaslSecurity

Field	Description
user	string
password	Password
supported_mechanisms[]	enum Mechanism `MECHANISM_UNSPECIFIED` `PLAIN` `SCRAM_SHA256` `SCRAM_SHA512`

RedisConnection

Field	Description
cluster	RedisCluster
auth	RedisAuth
databases[]	int64

RedisCluster

Field	Description
hosts[]	Host
sentinel_port	int64
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
role	enum Role `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
shard_name	string

RedisAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

UserPasswordAuth

Field	Description
user	string
password	Password

OpenSearchConnection

Field	Description
cluster	OpenSearchCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	OpenSearchAuth

OpenSearchCluster

Field	Description
hosts[]	Host
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `READONLY`
roles[]	enum GroupRole `GROUP_ROLE_UNSPECIFIED` `DATA` `MANAGER`

OpenSearchAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

TrinoConnection

Field	Description
cluster	TrinoCluster
auth	TrinoAuth

TrinoCluster

Field	Description
coordinator	Coordinator
tls_params	TLSParams

Coordinator

Field	Description
host	string
port	int64

TrinoAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

ValkeyConnection

Field	Description
cluster	ValkeyCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	ValkeyAuth
databases[]	int64

ValkeyCluster

Field	Description
hosts[]	Host
sentinel_port	int64
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
role	enum Role `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
shard_name	string

ValkeyAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

UserPasswordAuth

Field	Description
user	string
password	Password

GreenplumConnection

Field	Description
cluster	GreenplumCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	GreenplumAuth
databases[]	string

GreenplumCluster

Field	Description
coordinator_hosts[]	Host
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
role	enum Role `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `UNBALANCED`

GreenplumAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

StoreDocConnection

Field	Description
cluster	StoreDocCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	StoreDocAuth
databases[]	string

StoreDocCluster

Field	Description
hosts[]	Host
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
role	enum Role `ROLE_UNSPECIFIED` `PRIMARY` `SECONDARY`
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
type	enum Type `TYPE_UNSPECIFIED` `MONGOD` `MONGOS` `MONGOINFRA`

StoreDocAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

auth_source

string

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "connection_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "updated_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "created_by": "string",
    "params": {
      // Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`
      "postgresql": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "int64",
              "role": "Role",
              "replica_type": "ReplicaType",
              "health": "Health"
            }
          ],
          "tls_params": {
            // Includes only one of the fields `disabled`, `tls`
            "disabled": "google.protobuf.Empty",
            "tls": {
              "ca_certificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managed_cluster_id": "string",
        "auth": {
          // Includes only one of the fields `user_password`
          "user_password": {
            "user": "string",
            "password": {
              "raw": "string",
              "password_generation_options": {
                "cookie": "string",
                // Includes only one of the fields `lockbox_password_generation_options`
                "lockbox_password_generation_options": {
                  "length": "int64",
                  "include_uppercase": "google.protobuf.BoolValue",
                  "include_lowercase": "google.protobuf.BoolValue",
                  "include_digits": "google.protobuf.BoolValue",
                  "include_punctuation": "google.protobuf.BoolValue",
                  "included_punctuation": "string",
                  "excluded_punctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockbox_secret_key`
              "lockbox_secret_key": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        },
        "databases": [
          "string"
        ]
      },
      "mysql": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "int64",
              "role": "Role",
              "health": "Health"
            }
          ],
          "tls_params": {
            // Includes only one of the fields `disabled`, `tls`
            "disabled": "google.protobuf.Empty",
            "tls": {
              "ca_certificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managed_cluster_id": "string",
        "auth": {
          // Includes only one of the fields `user_password`
          "user_password": {
            "user": "string",
            "password": {
              "raw": "string",
              "password_generation_options": {
                "cookie": "string",
                // Includes only one of the fields `lockbox_password_generation_options`
                "lockbox_password_generation_options": {
                  "length": "int64",
                  "include_uppercase": "google.protobuf.BoolValue",
                  "include_lowercase": "google.protobuf.BoolValue",
                  "include_digits": "google.protobuf.BoolValue",
                  "include_punctuation": "google.protobuf.BoolValue",
                  "included_punctuation": "string",
                  "excluded_punctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockbox_secret_key`
              "lockbox_secret_key": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        },
        "databases": [
          "string"
        ]
      },
      "mongodb": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "int64",
              "role": "Role",
              "health": "Health",
              "type": "Type"
            }
          ],
          "tls_params": {
            // Includes only one of the fields `disabled`, `tls`
            "disabled": "google.protobuf.Empty",
            "tls": {
              "ca_certificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managed_cluster_id": "string",
        "auth": {
          // Includes only one of the fields `user_password`
          "user_password": {
            "user": "string",
            "password": {
              "raw": "string",
              "password_generation_options": {
                "cookie": "string",
                // Includes only one of the fields `lockbox_password_generation_options`
                "lockbox_password_generation_options": {
                  "length": "int64",
                  "include_uppercase": "google.protobuf.BoolValue",
                  "include_lowercase": "google.protobuf.BoolValue",
                  "include_digits": "google.protobuf.BoolValue",
                  "include_punctuation": "google.protobuf.BoolValue",
                  "included_punctuation": "string",
                  "excluded_punctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockbox_secret_key`
              "lockbox_secret_key": "string"
              // end of the list of possible fields
            }
          },
          // end of the list of possible fields
          "auth_source": "string"
        },
        "databases": [
          "string"
        ]
      },
      "clickhouse": {
        "cluster": {
          "tls_params": {
            // Includes only one of the fields `disabled`, `tls`
            "disabled": "google.protobuf.Empty",
            "tls": {
              "ca_certificate": "string"
            }
            // end of the list of possible fields
          },
          "hosts": [
            {
              "host": "string",
              "http_port": "int64",
              "tcp_port": "int64",
              "shard_name": "string",
              "health": "Health"
            }
          ],
          "shard_groups": [
            {
              "name": "string",
              "shard_names": [
                "string"
              ]
            }
          ]
        },
        "managed_cluster_id": "string",
        "auth": {
          // Includes only one of the fields `user_password`
          "user_password": {
            "user": "string",
            "password": {
              "raw": "string",
              "password_generation_options": {
                "cookie": "string",
                // Includes only one of the fields `lockbox_password_generation_options`
                "lockbox_password_generation_options": {
                  "length": "int64",
                  "include_uppercase": "google.protobuf.BoolValue",
                  "include_lowercase": "google.protobuf.BoolValue",
                  "include_digits": "google.protobuf.BoolValue",
                  "include_punctuation": "google.protobuf.BoolValue",
                  "included_punctuation": "string",
                  "excluded_punctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockbox_secret_key`
              "lockbox_secret_key": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        },
        "databases": [
          "string"
        ]
      },
      "kafka": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "int64",
              "health": "Health"
            }
          ],
          "tls_params": {
            // Includes only one of the fields `disabled`, `tls`
            "disabled": "google.protobuf.Empty",
            "tls": {
              "ca_certificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managed_cluster_id": "string",
        "auth": {
          // Includes only one of the fields `sasl`, `disabled`
          "sasl": {
            "user": "string",
            "password": {
              "raw": "string",
              "password_generation_options": {
                "cookie": "string",
                // Includes only one of the fields `lockbox_password_generation_options`
                "lockbox_password_generation_options": {
                  "length": "int64",
                  "include_uppercase": "google.protobuf.BoolValue",
                  "include_lowercase": "google.protobuf.BoolValue",
                  "include_digits": "google.protobuf.BoolValue",
                  "include_punctuation": "google.protobuf.BoolValue",
                  "included_punctuation": "string",
                  "excluded_punctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockbox_secret_key`
              "lockbox_secret_key": "string"
              // end of the list of possible fields
            },
            "supported_mechanisms": [
              "Mechanism"
            ]
          },
          "disabled": "google.protobuf.Empty"
          // end of the list of possible fields
        }
      },
      "redis": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "int64",
              "role": "Role",
              "health": "Health",
              "shard_name": "string"
            }
          ],
          "sentinel_port": "int64",
          "tls_params": {
            // Includes only one of the fields `disabled`, `tls`
            "disabled": "google.protobuf.Empty",
            "tls": {
              "ca_certificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "auth": {
          // Includes only one of the fields `user_password`
          "user_password": {
            "user": "string",
            "password": {
              "raw": "string",
              "password_generation_options": {
                "cookie": "string",
                // Includes only one of the fields `lockbox_password_generation_options`
                "lockbox_password_generation_options": {
                  "length": "int64",
                  "include_uppercase": "google.protobuf.BoolValue",
                  "include_lowercase": "google.protobuf.BoolValue",
                  "include_digits": "google.protobuf.BoolValue",
                  "include_punctuation": "google.protobuf.BoolValue",
                  "included_punctuation": "string",
                  "excluded_punctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockbox_secret_key`
              "lockbox_secret_key": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        },
        "databases": [
          "int64"
        ]
      },
      "opensearch": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "int64",
              "health": "Health",
              "roles": [
                "GroupRole"
              ]
            }
          ],
          "tls_params": {
            // Includes only one of the fields `disabled`, `tls`
            "disabled": "google.protobuf.Empty",
            "tls": {
              "ca_certificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managed_cluster_id": "string",
        "auth": {
          // Includes only one of the fields `user_password`
          "user_password": {
            "user": "string",
            "password": {
              "raw": "string",
              "password_generation_options": {
                "cookie": "string",
                // Includes only one of the fields `lockbox_password_generation_options`
                "lockbox_password_generation_options": {
                  "length": "int64",
                  "include_uppercase": "google.protobuf.BoolValue",
                  "include_lowercase": "google.protobuf.BoolValue",
                  "include_digits": "google.protobuf.BoolValue",
                  "include_punctuation": "google.protobuf.BoolValue",
                  "included_punctuation": "string",
                  "excluded_punctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockbox_secret_key`
              "lockbox_secret_key": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        }
      },
      "trino": {
        "cluster": {
          "coordinator": {
            "host": "string",
            "port": "int64"
          },
          "tls_params": {
            // Includes only one of the fields `disabled`, `tls`
            "disabled": "google.protobuf.Empty",
            "tls": {
              "ca_certificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "auth": {
          // Includes only one of the fields `user_password`
          "user_password": {
            "user": "string",
            "password": {
              "raw": "string",
              "password_generation_options": {
                "cookie": "string",
                // Includes only one of the fields `lockbox_password_generation_options`
                "lockbox_password_generation_options": {
                  "length": "int64",
                  "include_uppercase": "google.protobuf.BoolValue",
                  "include_lowercase": "google.protobuf.BoolValue",
                  "include_digits": "google.protobuf.BoolValue",
                  "include_punctuation": "google.protobuf.BoolValue",
                  "included_punctuation": "string",
                  "excluded_punctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockbox_secret_key`
              "lockbox_secret_key": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        }
      },
      "valkey": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "int64",
              "role": "Role",
              "health": "Health",
              "shard_name": "string"
            }
          ],
          "sentinel_port": "int64",
          "tls_params": {
            // Includes only one of the fields `disabled`, `tls`
            "disabled": "google.protobuf.Empty",
            "tls": {
              "ca_certificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managed_cluster_id": "string",
        "auth": {
          // Includes only one of the fields `user_password`
          "user_password": {
            "user": "string",
            "password": {
              "raw": "string",
              "password_generation_options": {
                "cookie": "string",
                // Includes only one of the fields `lockbox_password_generation_options`
                "lockbox_password_generation_options": {
                  "length": "int64",
                  "include_uppercase": "google.protobuf.BoolValue",
                  "include_lowercase": "google.protobuf.BoolValue",
                  "include_digits": "google.protobuf.BoolValue",
                  "include_punctuation": "google.protobuf.BoolValue",
                  "included_punctuation": "string",
                  "excluded_punctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockbox_secret_key`
              "lockbox_secret_key": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        },
        "databases": [
          "int64"
        ]
      },
      "greenplum": {
        "cluster": {
          "coordinator_hosts": [
            {
              "host": "string",
              "port": "int64",
              "role": "Role",
              "health": "Health"
            }
          ],
          "tls_params": {
            // Includes only one of the fields `disabled`, `tls`
            "disabled": "google.protobuf.Empty",
            "tls": {
              "ca_certificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managed_cluster_id": "string",
        "auth": {
          // Includes only one of the fields `user_password`
          "user_password": {
            "user": "string",
            "password": {
              "raw": "string",
              "password_generation_options": {
                "cookie": "string",
                // Includes only one of the fields `lockbox_password_generation_options`
                "lockbox_password_generation_options": {
                  "length": "int64",
                  "include_uppercase": "google.protobuf.BoolValue",
                  "include_lowercase": "google.protobuf.BoolValue",
                  "include_digits": "google.protobuf.BoolValue",
                  "include_punctuation": "google.protobuf.BoolValue",
                  "included_punctuation": "string",
                  "excluded_punctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockbox_secret_key`
              "lockbox_secret_key": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        },
        "databases": [
          "string"
        ]
      },
      "storedoc": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "int64",
              "role": "Role",
              "health": "Health",
              "type": "Type"
            }
          ],
          "tls_params": {
            // Includes only one of the fields `disabled`, `tls`
            "disabled": "google.protobuf.Empty",
            "tls": {
              "ca_certificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managed_cluster_id": "string",
        "auth": {
          // Includes only one of the fields `user_password`
          "user_password": {
            "user": "string",
            "password": {
              "raw": "string",
              "password_generation_options": {
                "cookie": "string",
                // Includes only one of the fields `lockbox_password_generation_options`
                "lockbox_password_generation_options": {
                  "length": "int64",
                  "include_uppercase": "google.protobuf.BoolValue",
                  "include_lowercase": "google.protobuf.BoolValue",
                  "include_digits": "google.protobuf.BoolValue",
                  "include_punctuation": "google.protobuf.BoolValue",
                  "included_punctuation": "string",
                  "excluded_punctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockbox_secret_key`
              "lockbox_secret_key": "string"
              // end of the list of possible fields
            }
          },
          // end of the list of possible fields
          "auth_source": "string"
        },
        "databases": [
          "string"
        ]
      }
      // end of the list of possible fields
    },
    // Includes only one of the fields `lockbox_secret`
    "lockbox_secret": {
      "id": "string",
      "version": "string",
      "newest_version": "string"
    },
    // end of the list of possible fields
    "is_managed": "bool",
    "can_use": "google.protobuf.BoolValue"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	UpdateConnectionMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Connection The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

UpdateConnectionMetadata

Field	Description
connection_id	string

Connection

Field	Description
id	string
folder_id	string
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp
name	string
description	string
labels	object (map<string, string>)
created_by	string
params	ConnectionParams
lockbox_secret	LockboxSecret Includes only one of the fields `lockbox_secret`.
is_managed	bool
can_use	google.protobuf.BoolValue

ConnectionParams

Field	Description
postgresql	PostgreSQLConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
mysql	MySQLConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
mongodb	MongoDBConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
clickhouse	ClickHouseConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
kafka	KafkaConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
redis	RedisConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
opensearch	OpenSearchConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
trino	TrinoConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
valkey	ValkeyConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
greenplum	GreenplumConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
storedoc	StoreDocConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.

PostgreSQLConnection

Field	Description
cluster	PostgreSQLCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	PostgreSQLAuth
databases[]	string

PostgreSQLCluster

Field	Description
hosts[]	Host
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
role	enum Role `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
replica_type	enum ReplicaType `REPLICA_TYPE_UNSPECIFIED` `ASYNC` `SYNC` `QUORUM`
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `READONLY`

TLSParams

Field

Description

disabled

google.protobuf.Empty

Includes only one of the fields disabled, tls.

tls

TLSConfig

Includes only one of the fields disabled, tls.

TLSConfig

Field	Description
ca_certificate	string

PostgreSQLAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

UserPasswordAuth

Field	Description
user	string
password	Password

Password

Field	Description
raw	string When creating/updating Password, the field "raw" is mutually exclusive with "password_generation_options". In order to switch to the "raw" password you have to explicitly clear the "password_generation_options" field.
password_generation_options	PasswordGenerationOptions When creating/updating Password, the field "password_generation_options" is mutually exclusive with "raw". In order to switch to the "password_generation_options" you have to explicitly clear the "raw" field.
lockbox_secret_key	string Read-only. Do not fill this field in create/update requests. Includes only one of the fields `lockbox_secret_key`.

PasswordGenerationOptions

Field

Description

string

lockbox_password_generation_options

LockboxPasswordGenerationOptions

Includes only one of the fields lockbox_password_generation_options.

LockboxPasswordGenerationOptions

Field	Description
length	int64 password length; by default, a reasonable length will be decided
include_uppercase	google.protobuf.BoolValue whether at least one A..Z character is included in the password, true by default
include_lowercase	google.protobuf.BoolValue whether at least one a..z character is included in the password, true by default
include_digits	google.protobuf.BoolValue whether at least one 0..9 character is included in the password, true by default
include_punctuation	google.protobuf.BoolValue whether at least one punctuation character is included in the password, true by default punctuation characters by default: !"#$%&'()*+,-./:;<=>?@[]^_`{\|}~ to customize the punctuation characters, see included_punctuation and excluded_punctuation below
included_punctuation	string If include_punctuation is true, one of these two fields (not both) may be used optionally to customize the punctuation: a string of specific punctuation characters to use
excluded_punctuation	string a string of punctuation characters to exclude from the default

MySQLConnection

Field	Description
cluster	MySQLCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	MySQLAuth
databases[]	string

MySQLCluster

Field	Description
hosts[]	Host
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
role	enum Role `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `READONLY`

MySQLAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

MongoDBConnection

Field	Description
cluster	MongoDBCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	MongoDBAuth
databases[]	string

MongoDBCluster

Field	Description
hosts[]	Host
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
role	enum Role `ROLE_UNSPECIFIED` `PRIMARY` `SECONDARY`
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
type	enum Type `TYPE_UNSPECIFIED` `MONGOD` `MONGOS` `MONGOINFRA`

MongoDBAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

auth_source

string

ClickHouseConnection

Field	Description
cluster	ClickHouseCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	ClickHouseAuth
databases[]	string

ClickHouseCluster

Field	Description
tls_params	TLSParams
hosts[]	Host
shard_groups[]	ShardGroup

Host

Field	Description
host	string
http_port	int64 depends on tls params may vary as http or https
tcp_port	int64
shard_name	string
health	enum Health `HEALTH_UNKNOWN` `ALIVE` `DEAD` `DEGRADED`

ShardGroup

Field	Description
name	string
shard_names[]	string

ClickHouseAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

KafkaConnection

Field	Description
cluster	KafkaCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	KafkaAuth

KafkaCluster

Field	Description
hosts[]	Host
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
health	enum Health `HEALTH_UNSPECIFIED`: Host is in unknown state (we have no data) `ALIVE`: Host is alive and well (all services are alive) `DEAD`: Host is inoperable (it cannot perform any of its essential functions) `DEGRADED`: Host is partially alive (it can perform some of its essential functions)

KafkaAuth

Field

Description

sasl

KafkaSaslSecurity

Includes only one of the fields sasl, disabled.

disabled

google.protobuf.Empty

Includes only one of the fields sasl, disabled.

KafkaSaslSecurity

Field	Description
user	string
password	Password
supported_mechanisms[]	enum Mechanism `MECHANISM_UNSPECIFIED` `PLAIN` `SCRAM_SHA256` `SCRAM_SHA512`

RedisConnection

Field	Description
cluster	RedisCluster
auth	RedisAuth
databases[]	int64

RedisCluster

Field	Description
hosts[]	Host
sentinel_port	int64
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
role	enum Role `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
shard_name	string

RedisAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

UserPasswordAuth

Field	Description
user	string
password	Password

OpenSearchConnection

Field	Description
cluster	OpenSearchCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	OpenSearchAuth

OpenSearchCluster

Field	Description
hosts[]	Host
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `READONLY`
roles[]	enum GroupRole `GROUP_ROLE_UNSPECIFIED` `DATA` `MANAGER`

OpenSearchAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

TrinoConnection

Field	Description
cluster	TrinoCluster
auth	TrinoAuth

TrinoCluster

Field	Description
coordinator	Coordinator
tls_params	TLSParams

Coordinator

Field	Description
host	string
port	int64

TrinoAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

ValkeyConnection

Field	Description
cluster	ValkeyCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	ValkeyAuth
databases[]	int64

ValkeyCluster

Field	Description
hosts[]	Host
sentinel_port	int64
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
role	enum Role `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
shard_name	string

ValkeyAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

UserPasswordAuth

Field	Description
user	string
password	Password

GreenplumConnection

Field	Description
cluster	GreenplumCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	GreenplumAuth
databases[]	string

GreenplumCluster

Field	Description
coordinator_hosts[]	Host
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
role	enum Role `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `UNBALANCED`

GreenplumAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

StoreDocConnection

Field	Description
cluster	StoreDocCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managed_cluster_id	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	StoreDocAuth
databases[]	string

StoreDocCluster

Field	Description
hosts[]	Host
tls_params	TLSParams

Host

Field	Description
host	string
port	int64
role	enum Role `ROLE_UNSPECIFIED` `PRIMARY` `SECONDARY`
health	enum Health `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
type	enum Type `TYPE_UNSPECIFIED` `MONGOD` `MONGOS` `MONGOINFRA`

StoreDocAuth

Field

Description

user_password

UserPasswordAuth

Includes only one of the fields user_password.

auth_source

string

LockboxSecret

Field	Description
id	string
version	string
newest_version	string

Connection Manager API, gRPC: ConnectionService.Update

gRPC requestgRPC request

UpdateConnectionRequestUpdateConnectionRequest

ConnectionParamsConnectionParams

PostgreSQLConnectionPostgreSQLConnection

PostgreSQLClusterPostgreSQLCluster

HostHost

TLSParamsTLSParams

TLSConfigTLSConfig

PostgreSQLAuthPostgreSQLAuth

UserPasswordAuthUserPasswordAuth

PasswordPassword

PasswordGenerationOptionsPasswordGenerationOptions

LockboxPasswordGenerationOptionsLockboxPasswordGenerationOptions

MySQLConnectionMySQLConnection

MySQLClusterMySQLCluster

HostHost

MySQLAuthMySQLAuth

MongoDBConnectionMongoDBConnection

MongoDBClusterMongoDBCluster

HostHost

MongoDBAuthMongoDBAuth

ClickHouseConnectionClickHouseConnection

ClickHouseClusterClickHouseCluster

HostHost

ShardGroupShardGroup

ClickHouseAuthClickHouseAuth

KafkaConnectionKafkaConnection

KafkaClusterKafkaCluster

HostHost

KafkaAuthKafkaAuth

KafkaSaslSecurityKafkaSaslSecurity

RedisConnectionRedisConnection

RedisClusterRedisCluster

HostHost

RedisAuthRedisAuth

UserPasswordAuthUserPasswordAuth

OpenSearchConnectionOpenSearchConnection

OpenSearchClusterOpenSearchCluster

HostHost

OpenSearchAuthOpenSearchAuth

TrinoConnectionTrinoConnection

TrinoClusterTrinoCluster

CoordinatorCoordinator

TrinoAuthTrinoAuth

ValkeyConnectionValkeyConnection

ValkeyClusterValkeyCluster

HostHost

ValkeyAuthValkeyAuth

UserPasswordAuthUserPasswordAuth

GreenplumConnectionGreenplumConnection

GreenplumClusterGreenplumCluster

HostHost

GreenplumAuthGreenplumAuth

StoreDocConnectionStoreDocConnection

StoreDocClusterStoreDocCluster

HostHost

StoreDocAuthStoreDocAuth

operation.Operationoperation.Operation

UpdateConnectionMetadataUpdateConnectionMetadata

ConnectionConnection

ConnectionParamsConnectionParams

PostgreSQLConnectionPostgreSQLConnection

PostgreSQLClusterPostgreSQLCluster

HostHost

TLSParamsTLSParams

TLSConfigTLSConfig

PostgreSQLAuthPostgreSQLAuth

UserPasswordAuthUserPasswordAuth

PasswordPassword

PasswordGenerationOptionsPasswordGenerationOptions

LockboxPasswordGenerationOptionsLockboxPasswordGenerationOptions

MySQLConnectionMySQLConnection

MySQLClusterMySQLCluster

HostHost

MySQLAuthMySQLAuth

MongoDBConnectionMongoDBConnection

MongoDBClusterMongoDBCluster

HostHost

MongoDBAuthMongoDBAuth

gRPC request

UpdateConnectionRequest

ConnectionParams

PostgreSQLConnection

PostgreSQLCluster

Host

TLSParams

TLSConfig

PostgreSQLAuth

UserPasswordAuth

Password

PasswordGenerationOptions

LockboxPasswordGenerationOptions

MySQLConnection

MySQLCluster

Host

MySQLAuth

MongoDBConnection

MongoDBCluster

Host

MongoDBAuth

ClickHouseConnection

ClickHouseCluster

Host

ShardGroup

ClickHouseAuth

KafkaConnection

KafkaCluster

Host

KafkaAuth

KafkaSaslSecurity

RedisConnection

RedisCluster

Host

RedisAuth

UserPasswordAuth

OpenSearchConnection

OpenSearchCluster

Host

OpenSearchAuth

TrinoConnection

TrinoCluster

Coordinator

TrinoAuth

ValkeyConnection

ValkeyCluster

Host

ValkeyAuth

UserPasswordAuth

GreenplumConnection

GreenplumCluster

Host

GreenplumAuth

StoreDocConnection

StoreDocCluster

Host

StoreDocAuth

operation.Operation

UpdateConnectionMetadata

Connection

ConnectionParams

PostgreSQLConnection

PostgreSQLCluster

Host

TLSParams

TLSConfig

PostgreSQLAuth

UserPasswordAuth

Password

PasswordGenerationOptions

LockboxPasswordGenerationOptions

MySQLConnection

MySQLCluster

Host

MySQLAuth

MongoDBConnection

MongoDBCluster

Host

MongoDBAuth

ClickHouseConnection