Path Parameters
The instance id.
Query Parameters
The list of fields to update.
Validate only also tests the data source connection.
If set to true, and the data source is not found, a new data source will be created.
In this situation, update_mask
is ignored.
Body
DATA_SOURCE_UNSPECIFIED
, ADMIN
, READ_ONLY
Use SSL to connect to the data source. By default, we use system default SSL configuration.
verify_tls_certificate enables TLS certificate verification for SSL connections. Default is false (no verification) for backward compatibility. Set to true for secure connections (recommended for production). Only set to false for development or when certificates cannot be properly validated (e.g., self-signed certs, VPN environments).
srv, authentication_database and replica_set are used for MongoDB. srv is a boolean flag that indicates whether the host is a DNS SRV record.
authentication_database is the database name to authenticate against, which stores the user credentials.
replica_set is used for MongoDB replica set.
sid and service_name are used for Oracle.
SSH related The hostname of the SSH server agent.
The port of the SSH server agent. It's 22 typically.
The user to login the server.
The password to login the server. If it's empty string, no password is required.
The private key to login the server. If it's empty string, we will use the system default private key from os.Getenv("SSH_AUTH_SOCK").
PKCS#8 private key in PEM format. If it's empty string, no private key is required. Used for authentication when connecting to the data source.
AUTHENTICATION_UNSPECIFIED
, PASSWORD
, GOOGLE_CLOUD_SQL_IAM
, AWS_RDS_IAM
, AZURE_IAM
additional_addresses is used for MongoDB replica set.
direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string.
region is the location of where the DB is, works for AWS RDS. For example, us-east-1.
warehouse_id is used by Databricks.
master_name is the master name used by connecting redis-master via redis sentinel.
master_username and master_obfuscated_password are master credentials used by redis sentinel mode.
REDIS_TYPE_UNSPECIFIED
, STANDALONE
, SENTINEL
, CLUSTER
Cluster is the cluster name for the data source. Used by CockroachDB.
Extra connection parameters for the database connection. For PostgreSQL HA, this can be used to set target_session_attrs=read-write
Response
OK
Instance is the proto for instances.
ENGINE_UNSPECIFIED
, CLICKHOUSE
, MYSQL
, POSTGRES
, SNOWFLAKE
, SQLITE
, TIDB
, MONGODB
, REDIS
, ORACLE
, SPANNER
, MSSQL
, REDSHIFT
, MARIADB
, OCEANBASE
, STARROCKS
, DORIS
, HIVE
, ELASTICSEARCH
, BIGQUERY
, DYNAMODB
, DATABRICKS
, COCKROACHDB
, COSMOSDB
, TRINO
, CASSANDRA
How often the instance is synced.
The maximum number of connections. The default is 10 if the value is unset or zero.
Enable sync for following databases. Default empty, means sync all schemas & databases.
The lower_case_table_names config for MySQL instances. It is used to determine whether the table names and database names are case sensitive.