ConnectSettings

Connect settings retrieval response.

JSON representation
{
  "kind": string,
  "serverCaCert": {
    object (SslCert)
  },
  "ipAddresses": [
    {
      object (IpMapping)
    }
  ],
  "region": string,
  "databaseVersion": enum (SqlDatabaseVersion),
  "backendType": enum (SqlBackendType),
  "pscEnabled": boolean,
  "dnsName": string,
  "serverCaMode": enum (CaMode),
  "customSubjectAlternativeNames": [
    string
  ],
  "dnsNames": [
    {
      object (DnsNameMapping)
    }
  ],
  "nodes": [
    {
      object (ConnectPoolNodeConfig)
    }
  ],
  "mdxProtocolSupport": [
    enum (MdxProtocolSupport)
  ],
  "connectionName": string,
  "nodeCount": integer
}
Fields
kind

string

This is always sql#connectSettings.

serverCaCert

object (SslCert)

SSL configuration.

ipAddresses[]

object (IpMapping)

The assigned IP addresses for the instance.

region

string

The cloud region for the instance. For example, us-central1, europe-west1. The region cannot be changed after instance creation.

databaseVersion

enum (SqlDatabaseVersion)

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.

backendType

enum (SqlBackendType)

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.

pscEnabled

boolean

Whether PSC connectivity is enabled for this instance.

dnsName

string

The dns name of the instance.

serverCaMode

enum (CaMode)

Specify what type of CA is used for the server certificate.

customSubjectAlternativeNames[]

string

Custom subject alternative names for the server certificate.

dnsNames[]

object (DnsNameMapping)

Output only. The list of DNS names used by this instance.

nodes[]

object (ConnectPoolNodeConfig)

Output only. Entries containing information about each read pool node of the read pool.

mdxProtocolSupport[]

enum (MdxProtocolSupport)

Optional. Output only. mdxProtocolSupport controls how the client uses metadata exchange when connecting to the instance. The values in the list representing parts of the MDX protocol that are supported by this instance. When the list is empty, the instance does not support MDX, so the client must not send an MDX request. The default is empty.

connectionName

string

Optional. Output only. Connection name of the Cloud SQL instance used in connection strings, in the format project:region:instance.

nodeCount

integer

The number of read pool nodes in a read pool.

CaMode

Various Certificate Authority (CA) modes for certificate signing.

Enums
CA_MODE_UNSPECIFIED CA mode is unknown.
GOOGLE_MANAGED_INTERNAL_CA Google-managed self-signed internal CA.
GOOGLE_MANAGED_CAS_CA Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS).
CUSTOMER_MANAGED_CAS_CA Customer-managed CA hosted on Google Cloud's Certificate Authority Service (CAS).

ConnectPoolNodeConfig

Details of a single read pool node of a read pool.

JSON representation
{
  "ipAddresses": [
    {
      object (IpMapping)
    }
  ],
  "dnsNames": [
    {
      object (DnsNameMapping)
    }
  ],
  "name": string,
  "dnsName": string
}
Fields
ipAddresses[]

object (IpMapping)

Output only. Mappings containing IP addresses that can be used to connect to the read pool node.

dnsNames[]

object (DnsNameMapping)

Output only. The list of DNS names used by this read pool node.

name

string

Output only. The name of the read pool node. Doesn't include the project ID.

dnsName

string

Output only. The DNS name of the read pool node.

MdxProtocolSupport

MdxProtocolSupport describes parts of the MDX protocol supported by this instance.

Enums
MDX_PROTOCOL_SUPPORT_UNSPECIFIED Not specified.
CLIENT_PROTOCOL_TYPE Client should send the client protocol type in the MDX request.