connect

Creates, updates, deletes, gets or lists a connect resource.

Overview

Name	connect
Type	Resource
Id	google.sqladmin.connect

Fields

Name	Datatype	Description
backendType	string	SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.
databaseVersion	string	The database engine type and version. The databaseVersion field cannot be changed after instance creation. MySQL instances: MYSQL_8_0, MYSQL_5_7 (default), or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12 (default), POSTGRES_13, or POSTGRES_14. SQL Server instances: SQLSERVER_2017_STANDARD (default), SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB, SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB.
dnsName	string	The dns name of the instance.
ipAddresses	array	The assigned IP addresses for the instance.
kind	string	This is always sql#connectSettings.
pscEnabled	boolean	Whether PSC connectivity is enabled for this instance.
region	string	The cloud region for the instance. For example, us-central1, europe-west1. The region cannot be changed after instance creation.
serverCaCert	object	SslCerts Resource
serverCaMode	string	Specify what type of CA is used for the server certificate.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	instance, project	Retrieves connect settings about a Cloud SQL instance.
generate_ephemeral	EXEC	instance, project	Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.

SELECT examples

Retrieves connect settings about a Cloud SQL instance.

SELECT
backendType,
databaseVersion,
dnsName,
ipAddresses,
kind,
pscEnabled,
region,
serverCaCert,
serverCaMode
FROM google.sqladmin.connect
WHERE instance = '{{ instance }}'
AND project = '{{ project }}';