connection_profiles

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

Overview

Name	`connection_profiles`
Type	Resource
Id	`google.datamigration.connection_profiles`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`name`	`string`	The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
`alloydb`	`object`	An AlloyDB cluster connection profile. (id: AlloyDbConnectionProfile)
`cloudsql`	`object`	A CloudSQL database connection profile. (id: CloudSqlConnectionProfile)
`createTime`	`string (google-datetime)`	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".
`displayName`	`string`	The connection profile display name.
`error`	`object`	Output only. The error details in case of state FAILED. (id: Status)
`labels`	`object`	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" }`.
`mysql`	`object`	A MySQL database connection profile. (id: MySqlConnectionProfile)
`oracle`	`object`	An Oracle database connection profile. (id: OracleConnectionProfile)
`postgresql`	`object`	A PostgreSQL database connection profile. (id: PostgreSqlConnectionProfile)
`provider`	`string`	The database provider. (DATABASE_PROVIDER_UNSPECIFIED, CLOUDSQL, RDS, AURORA, ALLOYDB, AZURE_DATABASE)
`role`	`string`	Optional. The connection profile role. (ROLE_UNSPECIFIED, SOURCE, DESTINATION)
`satisfiesPzi`	`boolean`	Output only. Reserved for future use.
`satisfiesPzs`	`boolean`	Output only. Reserved for future use.
`sqlserver`	`object`	Connection profile for a SQL Server data source. (id: SqlServerConnectionProfile)
`state`	`string`	The current connection profile state (e.g. DRAFT, READY, or FAILED). (STATE_UNSPECIFIED, DRAFT, CREATING, READY, UPDATING, DELETING, DELETED, FAILED)
`updateTime`	`string (google-datetime)`	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".

Name	Datatype	Description
`name`	`string`	The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
`alloydb`	`object`	An AlloyDB cluster connection profile. (id: AlloyDbConnectionProfile)
`cloudsql`	`object`	A CloudSQL database connection profile. (id: CloudSqlConnectionProfile)
`createTime`	`string (google-datetime)`	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".
`displayName`	`string`	The connection profile display name.
`error`	`object`	Output only. The error details in case of state FAILED. (id: Status)
`labels`	`object`	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" }`.
`mysql`	`object`	A MySQL database connection profile. (id: MySqlConnectionProfile)
`oracle`	`object`	An Oracle database connection profile. (id: OracleConnectionProfile)
`postgresql`	`object`	A PostgreSQL database connection profile. (id: PostgreSqlConnectionProfile)
`provider`	`string`	The database provider. (DATABASE_PROVIDER_UNSPECIFIED, CLOUDSQL, RDS, AURORA, ALLOYDB, AZURE_DATABASE)
`role`	`string`	Optional. The connection profile role. (ROLE_UNSPECIFIED, SOURCE, DESTINATION)
`satisfiesPzi`	`boolean`	Output only. Reserved for future use.
`satisfiesPzs`	`boolean`	Output only. Reserved for future use.
`sqlserver`	`object`	Connection profile for a SQL Server data source. (id: SqlServerConnectionProfile)
`state`	`string`	The current connection profile state (e.g. DRAFT, READY, or FAILED). (STATE_UNSPECIFIED, DRAFT, CREATING, READY, UPDATING, DELETING, DELETED, FAILED)
`updateTime`	`string (google-datetime)`	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `connectionProfilesId`		Gets details of a single connection profile.
`list`	`select`	`projectsId`, `locationsId`	`pageSize`, `pageToken`, `filter`, `orderBy`	Retrieves a list of all connection profiles in a given project and location.
`create`	`insert`	`projectsId`, `locationsId`	`connectionProfileId`, `requestId`, `validateOnly`, `skipValidation`	Creates a new connection profile in a given project and location.
`patch`	`update`	`projectsId`, `locationsId`, `connectionProfilesId`	`validateOnly`, `requestId`, `updateMask`, `skipValidation`	Update the configuration of a single connection profile.
`delete`	`delete`	`projectsId`, `locationsId`, `connectionProfilesId`	`requestId`, `force`	Deletes 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`connectionProfilesId`	`string`
`locationsId`	`string`
`projectsId`	`string`
`connectionProfileId`	`string`
`filter`	`string`
`force`	`boolean`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`requestId`	`string`
`skipValidation`	`boolean`
`updateMask`	`string (google-fieldmask)`
`validateOnly`	`boolean`

`SELECT` examples

get
list

Gets details of a single connection profile.

SELECT
name,
alloydb,
cloudsql,
createTime,
displayName,
error,
labels,
mysql,
oracle,
postgresql,
provider,
role,
satisfiesPzi,
satisfiesPzs,
sqlserver,
state,
updateTime
FROM google.datamigration.connection_profiles
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND connectionProfilesId = '{{ connectionProfilesId }}' -- required
;

Retrieves a list of all connection profiles in a given project and location.

SELECT
name,
alloydb,
cloudsql,
createTime,
displayName,
error,
labels,
mysql,
oracle,
postgresql,
provider,
role,
satisfiesPzi,
satisfiesPzs,
sqlserver,
state,
updateTime
FROM google.datamigration.connection_profiles
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;

`INSERT` examples

create
Manifest

Creates a new connection profile in a given project and location.

INSERT INTO google.datamigration.connection_profiles (
data__displayName,
data__name,
data__labels,
data__alloydb,
data__sqlserver,
data__state,
data__cloudsql,
data__postgresql,
data__oracle,
data__mysql,
data__provider,
data__role,
projectsId,
locationsId,
connectionProfileId,
requestId,
validateOnly,
skipValidation
)
SELECT 
'{{ displayName }}',
'{{ name }}',
'{{ labels }}',
'{{ alloydb }}',
'{{ sqlserver }}',
'{{ state }}',
'{{ cloudsql }}',
'{{ postgresql }}',
'{{ oracle }}',
'{{ mysql }}',
'{{ provider }}',
'{{ role }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ connectionProfileId }}',
'{{ requestId }}',
'{{ validateOnly }}',
'{{ skipValidation }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: connection_profiles
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the connection_profiles resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the connection_profiles resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The connection profile display name.
  - name: name
    value: "{{ name }}"
    description: |
      The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
  - name: labels
    value: "{{ labels }}"
    description: |
      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" }`.
  - name: alloydb
    description: |
      An AlloyDB cluster connection profile.
    value:
      clusterId: "{{ clusterId }}"
      settings:
        encryptionConfig:
          kmsKeyName: "{{ kmsKeyName }}"
        initialUser:
          passwordSet: {{ passwordSet }}
          user: "{{ user }}"
          password: "{{ password }}"
        vpcNetwork: "{{ vpcNetwork }}"
        databaseVersion: "{{ databaseVersion }}"
        primaryInstanceSettings:
          labels: "{{ labels }}"
          instanceNetworkConfig:
            authorizedExternalNetworks:
              - cidrRange: "{{ cidrRange }}"
            enableOutboundPublicIp: {{ enableOutboundPublicIp }}
            enablePublicIp: {{ enablePublicIp }}
          databaseFlags: "{{ databaseFlags }}"
          privateIp: "{{ privateIp }}"
          outboundPublicIpAddresses:
            - "{{ outboundPublicIpAddresses }}"
          machineConfig:
            machineType: "{{ machineType }}"
            cpuCount: {{ cpuCount }}
          id: "{{ id }}"
        labels: "{{ labels }}"
  - name: sqlserver
    description: |
      Connection profile for a SQL Server data source.
    value:
      database: "{{ database }}"
      port: {{ port }}
      forwardSshConnectivity:
        username: "{{ username }}"
        port: {{ port }}
        hostname: "{{ hostname }}"
        privateKey: "{{ privateKey }}"
        password: "{{ password }}"
      username: "{{ username }}"
      privateConnectivity:
        privateConnection: "{{ privateConnection }}"
      ssl:
        clientKey: "{{ clientKey }}"
        type: "{{ type }}"
        clientCertificate: "{{ clientCertificate }}"
        caCertificate: "{{ caCertificate }}"
        sslFlags: "{{ sslFlags }}"
      backups:
        gcsBucket: "{{ gcsBucket }}"
        gcsPrefix: "{{ gcsPrefix }}"
      passwordSet: {{ passwordSet }}
      dbmPort: {{ dbmPort }}
      password: "{{ password }}"
      cloudSqlProjectId: "{{ cloudSqlProjectId }}"
      cloudSqlId: "{{ cloudSqlId }}"
      privateServiceConnectConnectivity:
        serviceAttachment: "{{ serviceAttachment }}"
      host: "{{ host }}"
      staticIpConnectivity: "{{ staticIpConnectivity }}"
  - name: state
    value: "{{ state }}"
    description: |
      The current connection profile state (e.g. DRAFT, READY, or FAILED).
    valid_values: ['STATE_UNSPECIFIED', 'DRAFT', 'CREATING', 'READY', 'UPDATING', 'DELETING', 'DELETED', 'FAILED']
  - name: cloudsql
    description: |
      A CloudSQL database connection profile.
    value:
      settings:
        userLabels: "{{ userLabels }}"
        rootPassword: "{{ rootPassword }}"
        sourceId: "{{ sourceId }}"
        secondaryZone: "{{ secondaryZone }}"
        databaseVersion: "{{ databaseVersion }}"
        databaseVersionName: "{{ databaseVersionName }}"
        dataDiskSizeGb: "{{ dataDiskSizeGb }}"
        dataCacheConfig:
          dataCacheEnabled: {{ dataCacheEnabled }}
        activationPolicy: "{{ activationPolicy }}"
        autoStorageIncrease: {{ autoStorageIncrease }}
        zone: "{{ zone }}"
        storageAutoResizeLimit: "{{ storageAutoResizeLimit }}"
        dataDiskType: "{{ dataDiskType }}"
        rootPasswordSet: {{ rootPasswordSet }}
        dataDiskProvisionedIops: "{{ dataDiskProvisionedIops }}"
        dataDiskProvisionedThroughput: "{{ dataDiskProvisionedThroughput }}"
        availabilityType: "{{ availabilityType }}"
        cmekKeyName: "{{ cmekKeyName }}"
        edition: "{{ edition }}"
        tier: "{{ tier }}"
        databaseFlags: "{{ databaseFlags }}"
        ipConfig:
          enableIpv4: {{ enableIpv4 }}
          privateNetwork: "{{ privateNetwork }}"
          allocatedIpRange: "{{ allocatedIpRange }}"
          requireSsl: {{ requireSsl }}
          authorizedNetworks:
            - value: "{{ value }}"
              label: "{{ label }}"
              expireTime: "{{ expireTime }}"
              ttl: "{{ ttl }}"
        collation: "{{ collation }}"
      privateIp: "{{ privateIp }}"
      cloudSqlId: "{{ cloudSqlId }}"
      publicIp: "{{ publicIp }}"
      additionalPublicIp: "{{ additionalPublicIp }}"
  - name: postgresql
    description: |
      A PostgreSQL database connection profile.
    value:
      passwordSet: {{ passwordSet }}
      password: "{{ password }}"
      username: "{{ username }}"
      privateConnectivity:
        privateConnection: "{{ privateConnection }}"
      ssl:
        clientKey: "{{ clientKey }}"
        type: "{{ type }}"
        clientCertificate: "{{ clientCertificate }}"
        caCertificate: "{{ caCertificate }}"
        sslFlags: "{{ sslFlags }}"
      forwardSshConnectivity:
        username: "{{ username }}"
        port: {{ port }}
        hostname: "{{ hostname }}"
        privateKey: "{{ privateKey }}"
        password: "{{ password }}"
      networkArchitecture: "{{ networkArchitecture }}"
      database: "{{ database }}"
      port: {{ port }}
      host: "{{ host }}"
      enableIamAuthentication: {{ enableIamAuthentication }}
      staticIpConnectivity: "{{ staticIpConnectivity }}"
      cloudSqlId: "{{ cloudSqlId }}"
      privateServiceConnectConnectivity:
        serviceAttachment: "{{ serviceAttachment }}"
      alloydbClusterId: "{{ alloydbClusterId }}"
  - name: oracle
    description: |
      An Oracle database connection profile.
    value:
      databaseService: "{{ databaseService }}"
      staticServiceIpConnectivity: "{{ staticServiceIpConnectivity }}"
      host: "{{ host }}"
      passwordSet: {{ passwordSet }}
      password: "{{ password }}"
      username: "{{ username }}"
      privateConnectivity:
        privateConnection: "{{ privateConnection }}"
      oracleAsmConfig:
        username: "{{ username }}"
        ssl:
          clientKey: "{{ clientKey }}"
          type: "{{ type }}"
          clientCertificate: "{{ clientCertificate }}"
          caCertificate: "{{ caCertificate }}"
          sslFlags: "{{ sslFlags }}"
        port: {{ port }}
        hostname: "{{ hostname }}"
        passwordSet: {{ passwordSet }}
        asmService: "{{ asmService }}"
        password: "{{ password }}"
      ssl:
        clientKey: "{{ clientKey }}"
        type: "{{ type }}"
        clientCertificate: "{{ clientCertificate }}"
        caCertificate: "{{ caCertificate }}"
        sslFlags: "{{ sslFlags }}"
      forwardSshConnectivity:
        username: "{{ username }}"
        port: {{ port }}
        hostname: "{{ hostname }}"
        privateKey: "{{ privateKey }}"
        password: "{{ password }}"
      port: {{ port }}
  - name: mysql
    description: |
      A MySQL database connection profile.
    value:
      port: {{ port }}
      ssl:
        clientKey: "{{ clientKey }}"
        type: "{{ type }}"
        clientCertificate: "{{ clientCertificate }}"
        caCertificate: "{{ caCertificate }}"
        sslFlags: "{{ sslFlags }}"
      cloudSqlId: "{{ cloudSqlId }}"
      username: "{{ username }}"
      password: "{{ password }}"
      host: "{{ host }}"
      passwordSet: {{ passwordSet }}
  - name: provider
    value: "{{ provider }}"
    description: |
      The database provider.
    valid_values: ['DATABASE_PROVIDER_UNSPECIFIED', 'CLOUDSQL', 'RDS', 'AURORA', 'ALLOYDB', 'AZURE_DATABASE']
  - name: role
    value: "{{ role }}"
    description: |
      Optional. The connection profile role.
    valid_values: ['ROLE_UNSPECIFIED', 'SOURCE', 'DESTINATION']
  - name: connectionProfileId
    value: "{{ connectionProfileId }}"
  - name: requestId
    value: "{{ requestId }}"
  - name: validateOnly
    value: {{ validateOnly }}
  - name: skipValidation
    value: {{ skipValidation }}

`UPDATE` examples

patch

Update the configuration of a single connection profile.

UPDATE google.datamigration.connection_profiles
SET 
data__displayName = '{{ displayName }}',
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__alloydb = '{{ alloydb }}',
data__sqlserver = '{{ sqlserver }}',
data__state = '{{ state }}',
data__cloudsql = '{{ cloudsql }}',
data__postgresql = '{{ postgresql }}',
data__oracle = '{{ oracle }}',
data__mysql = '{{ mysql }}',
data__provider = '{{ provider }}',
data__role = '{{ role }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND connectionProfilesId = '{{ connectionProfilesId }}' --required
AND validateOnly = {{ validateOnly}}
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
AND skipValidation = {{ skipValidation}}
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

delete

Deletes 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.

DELETE FROM google.datamigration.connection_profiles
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND connectionProfilesId = '{{ connectionProfilesId }}' --required
AND requestId = '{{ requestId }}'
AND force = '{{ force }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​