REST Resource: projects.locations.connectionProfiles

Resource: ConnectionProfile

A connection profile definition.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "displayName": string,
  "error": {
    object (Status)
  },
  "provider": enum (DatabaseProvider),

  // Union field connection_profile can be only one of the following:
  "mysql": {
    object (MySqlConnectionProfile)
  },
  "postgresql": {
    object (PostgreSqlConnectionProfile)
  },
  "sqlserver": {
    object (SqlServerConnectionProfile)
  },
  "oracle": {
    object (OracleConnectionProfile)
  },
  "cloudsql": {
    object (CloudSqlConnectionProfile)
  },
  "alloydb": {
    object (AlloyDbConnectionProfile)
  }
  // End of list of possible types for union field connection_profile.
}
Fields
name

string

The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
createTime

string (Timestamp format)

Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
state

enum (State)

The current connection profile state (e.g. DRAFT, READY, or FAILED).
displayName

string

The connection profile display name.
error

object (Status)

Output only. The error details in case of state FAILED.
provider

enum (DatabaseProvider)

The database provider.
Union field connection_profile. The connection profile definition. connection_profile can be only one of the following:
mysql

object (MySqlConnectionProfile)

A MySQL database connection profile.
postgresql

object (PostgreSqlConnectionProfile)

A PostgreSQL database connection profile.
sqlserver

object (SqlServerConnectionProfile)

Connection profile for a SQL Server data source.
oracle

object (OracleConnectionProfile)

An Oracle database connection profile.
cloudsql

object (CloudSqlConnectionProfile)

A CloudSQL database connection profile.
alloydb

object (AlloyDbConnectionProfile)

An AlloyDB cluster connection profile.

State

The current connection profile state (e.g. DRAFT, READY, or FAILED).

Enums
STATE_UNSPECIFIED The state of the connection profile is unknown.
DRAFT The connection profile is in draft mode and fully editable.
CREATING The connection profile is being created.
READY The connection profile is ready.
UPDATING The connection profile is being updated.
DELETING The connection profile is being deleted.
DELETED The connection profile has been deleted.
FAILED The last action on the connection profile failed.

MySqlConnectionProfile

Specifies connection parameters required specifically for MySQL databases.

JSON representation 
{
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "passwordSet": boolean,
  "ssl": {
    object (SslConfig)
  },
  "cloudSqlId": string
}
Fields
host

string

Required. The IP or hostname of the source MySQL database.
port

integer

Required. The network port of the source MySQL database.
username

string

Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
password

string

Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
passwordSet

boolean

Output only. Indicates If this connection profile password is stored.
ssl

object (SslConfig)

SSL configuration for the destination to connect to the source database.
cloudSqlId

string

If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

SslConfig

SSL configuration information.

JSON representation 
{
  "type": enum (SslType),
  "clientKey": string,
  "clientCertificate": string,
  "caCertificate": string
}
Fields
type

enum (SslType)

Output only. The ssl config type according to 'clientKey', 'clientCertificate' and 'caCertificate'.
clientKey

string

Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'clientCertificate' field is mandatory.
clientCertificate

string

Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'clientKey' field is mandatory.
caCertificate

string

Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.

SslType

Specifies The kind of ssl configuration used.

Enums
SSL_TYPE_UNSPECIFIED Unspecified.
SERVER_ONLY Only 'caCertificate' specified.
SERVER_CLIENT Both server ('caCertificate'), and client ('clientKey', 'clientCertificate') specified.

PostgreSqlConnectionProfile

Specifies connection parameters required specifically for PostgreSQL databases.

JSON representation 
{
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "passwordSet": boolean,
  "ssl": {
    object (SslConfig)
  },
  "cloudSqlId": string,
  "alloydbClusterId": string,
  "networkArchitecture": enum (NetworkArchitecture),

  // Union field connectivity can be only one of the following:
  "staticIpConnectivity": {
    object (StaticIpConnectivity)
  },
  "privateServiceConnectConnectivity": {
    object (PrivateServiceConnectConnectivity)
  }
  // End of list of possible types for union field connectivity.
}
Fields
host

string

Required. The IP or hostname of the source PostgreSQL database.
port

integer

Required. The network port of the source PostgreSQL database.
username

string

Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
password

string

Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
passwordSet

boolean

Output only. Indicates If this connection profile password is stored.
ssl

object (SslConfig)

SSL configuration for the destination to connect to the source database.
cloudSqlId

string

If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
alloydbClusterId

string

Optional. If the destination is an AlloyDB database, use this field to provide the AlloyDB cluster ID.
networkArchitecture

enum (NetworkArchitecture)

Output only. If the source is a Cloud SQL database, this field indicates the network architecture it's associated with.
Union field connectivity. Connectivity options used to establish a connection to the database server. connectivity can be only one of the following:
staticIpConnectivity

object (StaticIpConnectivity)

Static ip connectivity data (default, no additional details needed).
privateServiceConnectConnectivity

object (PrivateServiceConnectConnectivity)

Private service connect connectivity.

NetworkArchitecture

Enums
NETWORK_ARCHITECTURE_UNSPECIFIED
NETWORK_ARCHITECTURE_OLD_CSQL_PRODUCER Instance is in Cloud SQL's old producer network architecture.
NETWORK_ARCHITECTURE_NEW_CSQL_PRODUCER Instance is in Cloud SQL's new producer network architecture.

PrivateServiceConnectConnectivity

Private Service Connect connectivity

JSON representation 
{
  "serviceAttachment": string
}
Fields
serviceAttachment

string

Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}

SqlServerConnectionProfile

Specifies connection parameters required specifically for SQL Server databases.

JSON representation 
{
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "passwordSet": boolean,
  "ssl": {
    object (SslConfig)
  },
  "cloudSqlId": string,
  "backups": {
    object (SqlServerBackups)
  },

  // Union field connectivity can be only one of the following:
  "staticIpConnectivity": {
    object (StaticIpConnectivity)
  },
  "forwardSshConnectivity": {
    object (ForwardSshTunnelConnectivity)
  },
  "privateConnectivity": {
    object (PrivateConnectivity)
  },
  "privateServiceConnectConnectivity": {
    object (