- Resource: ConnectionProfile
- State
- MySqlConnectionProfile
- SslConfig
- SslType
- PostgreSqlConnectionProfile
- NetworkArchitecture
- PrivateServiceConnectConnectivity
- SqlServerConnectionProfile
- SqlServerBackups
- ForwardSshTunnelConnectivity
- PrivateConnectivity
- OracleConnectionProfile
- StaticServiceIpConnectivity
- CloudSqlConnectionProfile
- CloudSqlSettings
- SqlDatabaseVersion
- SqlActivationPolicy
- SqlIpConfig
- SqlAclEntry
- SqlDataDiskType
- SqlAvailabilityType
- Edition
- DataCacheConfig
- AlloyDbConnectionProfile
- AlloyDbSettings
- UserPassword
- PrimaryInstanceSettings
- MachineConfig
- EncryptionConfig
- DatabaseVersion
- Methods
Resource: ConnectionProfile
A connection profile definition.
JSON representation |
---|
{ "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "state": enum ( |
Fields | |
---|---|
name |
The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. |
createTime |
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: |
updateTime |
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: |
labels |
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: An object containing a list of |
state |
The current connection profile state (e.g. DRAFT, READY, or FAILED). |
displayName |
The connection profile display name. |
error |
Output only. The error details in case of state FAILED. |
provider |
The database provider. |
Union field connection_profile . The connection profile definition. connection_profile can be only one of the following: |
|
mysql |
A MySQL database connection profile. |
postgresql |
A PostgreSQL database connection profile. |
sqlserver |
Connection profile for a SQL Server data source. |
oracle |
An Oracle database connection profile. |
cloudsql |
A CloudSQL database connection profile. |
alloydb |
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 ( |
Fields | |
---|---|
host |
Required. The IP or hostname of the source MySQL database. |
port |
Required. The network port of the source MySQL database. |
username |
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 |
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 |
Output only. Indicates If this connection profile password is stored. |
ssl |
SSL configuration for the destination to connect to the source database. |
cloudSqlId |
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 ( |
Fields | |
---|---|
type |
Output only. The ssl config type according to 'clientKey', 'clientCertificate' and 'caCertificate'. |
clientKey |
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 |
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 |
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 ( |
Fields | |
---|---|
host |
Required. The IP or hostname of the source PostgreSQL database. |
port |
Required. The network port of the source PostgreSQL database. |
username |
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 |
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 |
Output only. Indicates If this connection profile password is stored. |
ssl |
SSL configuration for the destination to connect to the source database. |
cloudSqlId |
If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. |
alloydbClusterId |
Optional. If the destination is an AlloyDB database, use this field to provide the AlloyDB cluster ID. |
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 |
Static ip connectivity data (default, no additional details needed). |
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
JSON representation |
---|
{ "serviceAttachment": string } |
Fields | |
---|---|
serviceAttachment |
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 ( |
Fields | |
---|---|
host |
Required. The IP or hostname of the source SQL Server database. |
port |
Required. The network port of the source SQL Server database. |
username |
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 |
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 |
Output only. Indicates whether a new password is included in the request. |
ssl |
SSL configuration for the destination to connect to the source database. |
cloudSqlId |
If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. |
backups |
The backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. |
Union field connectivity . Connectivity options used to establish a connection to the database server. connectivity can be only one of the following: |
|
staticIpConnectivity |
Static IP connectivity data (default, no additional details needed). |
forwardSshConnectivity |
Forward SSH tunnel connectivity. |
privateConnectivity |
Private connectivity. |
privateServiceConnectConnectivity |
Private Service Connect connectivity. |
SqlServerBackups
Specifies the backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.
JSON representation |
---|
{ "gcsBucket": string, "gcsPrefix": string } |
Fields | |
---|---|
gcsBucket |
Required. The Cloud Storage bucket that stores backups for all replicated databases. |
gcsPrefix |
Optional. Cloud Storage path inside the bucket that stores backups. |
ForwardSshTunnelConnectivity
Forward SSH Tunnel connectivity.
JSON representation |
---|
{ "hostname": string, "username": string, "port": integer, // Union field |
Fields | |
---|---|
hostname |
Required. Hostname for the SSH tunnel. |
username |
Required. Username for the SSH tunnel. |
port |
Port for the SSH tunnel, default value is 22. |
Union field
|
|
password |
Input only. SSH password. |
privateKey |
Input only. SSH private key. |
PrivateConnectivity
Private Connectivity.
JSON representation |
---|
{ "privateConnection": string } |
Fields | |
---|---|
privateConnection |
Required. The resource name (URI) of the private connection. |
OracleConnectionProfile
Specifies connection parameters required specifically for Oracle databases.
JSON representation |
---|
{ "host": string, "port": integer, "username": string, "password": string, "passwordSet": boolean, "databaseService": string, "ssl": { object ( |
Fields | |
---|---|
host |
Required. The IP or hostname of the source Oracle database. |
port |
Required. The network port of the source Oracle database. |
username |
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 |
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 |
Output only. Indicates whether a new password is included in the request. |
databaseService |
Required. Database service for the Oracle connection. |
ssl |
SSL configuration for the connection to the source Oracle database.
|
Union field connectivity . Connectivity options used to establish a connection to the database server. connectivity can be only one of the following: |
|
staticServiceIpConnectivity |
Static Service IP connectivity. |
forwardSshConnectivity |
Forward SSH tunnel connectivity. |
privateConnectivity |
Private connectivity. |
StaticServiceIpConnectivity
This type has no fields.
Static IP address connectivity configured on service project.
CloudSqlConnectionProfile
Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance.
JSON representation |
---|
{
"cloudSqlId": string,
"settings": {
object ( |
Fields | |
---|---|
cloudSqlId |
Output only. The Cloud SQL instance ID that this connection profile is associated with. |
settings |
Immutable. Metadata used to create the destination Cloud SQL database. |
privateIp |
Output only. The Cloud SQL database instance's private IP. |
publicIp |
Output only. The Cloud SQL database instance's public IP. |
additionalPublicIp |
Output only. The Cloud SQL database instance's additional (outgoing) public IP. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available). |
CloudSqlSettings
Settings for creating a Cloud SQL database instance.
JSON representation |
---|
{ "databaseVersion": enum ( |
Fields | |
---|---|
databaseVersion |
The database engine type and version. |
userLabels |
The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: An object containing a list of |
tier |
The tier (or machine type) for this instance, for example: |
storageAutoResizeLimit |
The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. |
activationPolicy |
The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests.
|
ipConfig |
The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled. |
autoStorageIncrease |
[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB. |
databaseFlags |
The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. An object containing a list of |
dataDiskType |
The type of storage: |
dataDiskSizeGb |
The storage capacity available to the database, in GB. The minimum (and default) size is 10GB. |
zone |
The Google Cloud Platform zone where your Cloud SQL database instance is located. |
secondaryZone |
Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available). |
sourceId |
The Database Migration Service source connection profile ID, in the format: |
rootPassword |
Input only. Initial root password. |
rootPasswordSet |
Output only. Indicates If this connection profile root password is stored. |
collation |
The Cloud SQL default instance level collation. |
cmekKeyName |
The KMS key name used for the csql instance. |
availabilityType |
Optional. Availability type. Potential values: * |
edition |
Optional. The edition of the given Cloud SQL instance. |
dataCacheConfig |
Optional. Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see Data cache overview in Cloud SQL documentation. |
SqlDatabaseVersion
The database engine type and version.
Enums | |
---|---|
SQL_DATABASE_VERSION_UNSPECIFIED |
Unspecified version. |
MYSQL_5_6 |
MySQL 5.6. |
MYSQL_5_7 |
MySQL 5.7. |
MYSQL_8_0 |
MySQL 8.0. |
MYSQL_8_0_18 |
The database major version is MySQL 8.0 and the minor version is 18. |
MYSQL_8_0_26 |
The database major version is MySQL 8.0 and the minor version is 26. |
MYSQL_8_0_27 |
The database major version is MySQL 8.0 and the minor version is 27. |
MYSQL_8_0_28 |
The database major version is MySQL 8.0 and the minor version is 28. |
MYSQL_8_0_30 |
The database major version is MySQL 8.0 and the minor version is 30. |
MYSQL_8_0_31 |
The database major version is MySQL 8.0 and the minor version is 31. |
MYSQL_8_0_32 |
The database major version is MySQL 8.0 and the minor version is 32. |
MYSQL_8_0_33 |
The database major version is MySQL 8.0 and the minor version is 33. |
MYSQL_8_0_34 |
The database major version is MySQL 8.0 and the minor version is 34. |
MYSQL_8_0_35 |
The database major version is MySQL 8.0 and the minor version is 35. |
POSTGRES_9_6 |
PostgreSQL 9.6. |
POSTGRES_11 |
PostgreSQL 11. |
POSTGRES_10 |
PostgreSQL 10. |
POSTGRES_12 |
PostgreSQL 12. |
POSTGRES_13 |
PostgreSQL 13. |
POSTGRES_14 |
PostgreSQL 14. |
POSTGRES_15 |
PostgreSQL 15. |
SqlActivationPolicy
Specifies when the instance should be activated.
Enums | |
---|---|
SQL_ACTIVATION_POLICY_UNSPECIFIED |
unspecified policy. |
ALWAYS |
The instance is always up and running. |
NEVER |
The instance should never spin up. |
SqlIpConfig
IP Management configuration.
JSON representation |
---|
{
"enableIpv4": boolean,
"privateNetwork": string,
"allocatedIpRange": string,
"requireSsl": boolean,
"authorizedNetworks": [
{
object ( |
Fields | |
---|---|
enableIpv4 |
Whether the instance should be assigned an IPv4 address or not. |
privateNetwork |
The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, |
allocatedIpRange |
Optional. The name of the allocated IP address range for the private IP Cloud SQL instance. This name refers to an already allocated IP range address. If set, the instance IP address will be created in the allocated range. Note that this IP address range can't be modified after the instance is created. If you change the VPC when configuring connectivity settings for the migration job, this field is not relevant. |
requireSsl |
Whether SSL connections over IP should be enforced or not. |
authorizedNetworks[] |
The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation (e.g. |
SqlAclEntry
An entry for an Access Control list.
JSON representation |
---|
{ "value": string, "label": string, // Union field |
Fields | |
---|---|
value |
The allowlisted value for the access control list. |
label |
A label to identify this entry. |
Union field expiration . The access control entry entry expiration. expiration can be only one of the following: |
|
expireTime |
The time when this access control entry expires in RFC 3339 format, for example: A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
ttl |
Input only. The time-to-leave of this access control entry. A duration in seconds with up to nine fractional digits, ending with ' |
SqlDataDiskType
The storage options for Cloud SQL databases.
Enums | |
---|---|
SQL_DATA_DISK_TYPE_UNSPECIFIED |
Unspecified. |
PD_SSD |
SSD disk. |
PD_HDD |
HDD disk. |
SqlAvailabilityType
The availability type of the given Cloud SQL instance.
Enums | |
---|---|
SQL_AVAILABILITY_TYPE_UNSPECIFIED |
This is an unknown Availability type. |
ZONAL |
Zonal availablility instance. |
REGIONAL |
Regional availability instance. |
Edition
The edition of the given Cloud SQL instance. Can be ENTERPRISE or ENTERPRISE_PLUS.
Enums | |
---|---|
EDITION_UNSPECIFIED |
The instance did not specify the edition. |
ENTERPRISE |
The instance is an enterprise edition. |
ENTERPRISE_PLUS |
The instance is an enterprise plus edition. |
DataCacheConfig
Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see Data cache overview in Cloud SQL documentation.
JSON representation |
---|
{ "dataCacheEnabled": boolean } |
Fields | |
---|---|
dataCacheEnabled |
Optional. Whether data cache is enabled for the instance. |
AlloyDbConnectionProfile
Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster.
JSON representation |
---|
{
"clusterId": string,
"settings": {
object ( |
Fields | |
---|---|
clusterId |
Required. The AlloyDB cluster ID that this connection profile is associated with. |
settings |
Immutable. Metadata used to create the destination AlloyDB cluster. |
AlloyDbSettings
Settings for creating an AlloyDB cluster.
JSON representation |
---|
{ "initialUser": { object ( |
Fields | |
---|---|
initialUser |
Required. Input only. Initial user to setup during cluster creation. Required. |
vpcNetwork |
Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster. |
labels |
Labels for the AlloyDB cluster created by DMS. An object containing a list of 'key', 'value' pairs. An object containing a list of |
primaryInstanceSettings |
|
encryptionConfig |
Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data. |
databaseVersion |
Optional. The database engine major version. This is an optional field. If a database version is not supplied at cluster creation time, then a default database version will be used. |
UserPassword
The username/password for a database user. Used for specifying initial users at cluster creation time.
JSON representation |
---|
{ "user": string, "password": string, "passwordSet": boolean } |
Fields | |
---|---|
user |
The database username. |
password |
The initial password for the user. |
passwordSet |
Output only. Indicates if the initialUser.password field has been set. |
PrimaryInstanceSettings
Settings for the cluster's primary instance
JSON representation |
---|
{
"id": string,
"machineConfig": {
object ( |
Fields | |
---|---|
id |
Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+". |
machineConfig |
Configuration for the machines that host the underlying database engine. |
databaseFlags |
Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used. An object containing a list of |
labels |
Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs. An object containing a list of |
privateIp |
Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application. |
MachineConfig
MachineConfig describes the configuration of a machine.
JSON representation |
---|
{ "cpuCount": integer } |
Fields | |
---|---|
cpuCount |
The number of CPU's in the VM instance. |
EncryptionConfig
EncryptionConfig describes the encryption config of a cluster that is encrypted with a CMEK (customer-managed encryption key).
JSON representation |
---|
{ "kmsKeyName": string } |
Fields | |
---|---|
kmsKeyName |
The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME] |
DatabaseVersion
The supported database engine versions.
Enums | |
---|---|
DATABASE_VERSION_UNSPECIFIED |
This is an unknown database version. |
POSTGRES_14 |
The database version is Postgres 14. |
POSTGRES_15 |
The database version is Postgres 15. |
Methods |
|
---|---|
|
Creates a new connection profile in a given project and location. |
|
Deletes a single Database Migration Service connection profile. |
|
Gets details of a single connection profile. |
|
Gets the access control policy for a resource. |
|
Retrieves a list of all connection profiles in a given project and location. |
|
Update the configuration of a single connection profile. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |