Skip to main content

connection_profiles

Overview

Nameconnection_profiles
TypeResource
Idgoogle.datamigration.connection_profiles

Fields

NameDatatypeDescription
namestringThe name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
labelsobjectThe 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" }.
cloudsqlobjectSpecifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance.
displayNamestringThe connection profile display name.
mysqlobjectSpecifies connection parameters required specifically for MySQL databases.
updateTimestringOutput 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".
alloydbobjectSpecifies required connection parameters, and the parameters required to create an AlloyDB destination cluster.
createTimestringOutput 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".
statestringThe current connection profile state (e.g. DRAFT, READY, or FAILED).
oracleobjectSpecifies connection parameters required specifically for Oracle databases.
postgresqlobjectSpecifies connection parameters required specifically for PostgreSQL databases.
errorobjectThe Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
providerstringThe database provider.

Methods

NameAccessible byRequired ParamsDescription
getSELECTconnectionProfilesId, locationsId, projectsIdGets details of a single connection profile.
listSELECTlocationsId, projectsIdRetrieves a list of all connection profiles in a given project and location.
createINSERTlocationsId, projectsIdCreates a new connection profile in a given project and location.
deleteDELETEconnectionProfilesId, locationsId, projectsIdDeletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.
_listEXEClocationsId, projectsIdRetrieves a list of all connection profiles in a given project and location.
patchEXECconnectionProfilesId, locationsId, projectsIdUpdate the configuration of a single connection profile.