private_connections

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

Overview

Name	private_connections
Type	Resource
Id	google.datamigration.private_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	The name of the resource.
createTime	string (google-datetime)	Output only. The create time of the resource.
displayName	string	The private connection display name.
error	object	Output only. The error details in case of state FAILED. (id: Status)
labels	object	The resource labels for private connections 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" }.
pscInterfaceConfig	object	PSC Interface configuration. (id: PscInterfaceConfig)
reservedPublicIpConfig	object	Reserved Public IP configuration. (id: ReservedPublicIpConfig)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. The state of the private connection. (STATE_UNSPECIFIED, CREATING, CREATED, FAILED, DELETING, FAILED_TO_DELETE, DELETED)
updateTime	string (google-datetime)	Output only. The last update time of the resource.
vpcPeeringConfig	object	VPC peering configuration. (id: VpcPeeringConfig)

list

Name	Datatype	Description
name	string	The name of the resource.
createTime	string (google-datetime)	Output only. The create time of the resource.
displayName	string	The private connection display name.
error	object	Output only. The error details in case of state FAILED. (id: Status)
labels	object	The resource labels for private connections 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" }.
pscInterfaceConfig	object	PSC Interface configuration. (id: PscInterfaceConfig)
reservedPublicIpConfig	object	Reserved Public IP configuration. (id: ReservedPublicIpConfig)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. The state of the private connection. (STATE_UNSPECIFIED, CREATING, CREATED, FAILED, DELETING, FAILED_TO_DELETE, DELETED)
updateTime	string (google-datetime)	Output only. The last update time of the resource.
vpcPeeringConfig	object	VPC peering configuration. (id: VpcPeeringConfig)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, privateConnectionsId		Gets details of a single private connection.
list	select	projectsId, locationsId	filter, orderBy, pageSize, pageToken	Retrieves a list of private connections in a given project and location.
create	insert	projectsId, locationsId	privateConnectionId, requestId, skipValidation, validateOnly	Creates a new private connection in a given project and location.
delete	delete	projectsId, locationsId, privateConnectionsId	requestId	Deletes a single Database Migration Service private connection.

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
locationsId	string
privateConnectionsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
privateConnectionId	string
requestId	string
skipValidation	boolean
validateOnly	boolean

SELECT examples

get

Gets details of a single private connection.

SELECT
name,
createTime,
displayName,
error,
labels,
pscInterfaceConfig,
reservedPublicIpConfig,
satisfiesPzi,
satisfiesPzs,
state,
updateTime,
vpcPeeringConfig
FROM google.datamigration.private_connections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateConnectionsId = '{{ privateConnectionsId }}' -- required
;

list

Retrieves a list of private connections in a given project and location.

SELECT
name,
createTime,
displayName,
error,
labels,
pscInterfaceConfig,
reservedPublicIpConfig,
satisfiesPzi,
satisfiesPzs,
state,
updateTime,
vpcPeeringConfig
FROM google.datamigration.private_connections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

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

INSERT INTO google.datamigration.private_connections (
data__displayName,
data__labels,
data__name,
data__pscInterfaceConfig,
data__reservedPublicIpConfig,
data__vpcPeeringConfig,
projectsId,
locationsId,
privateConnectionId,
requestId,
skipValidation,
validateOnly
)
SELECT 
'{{ displayName }}',
'{{ labels }}',
'{{ name }}',
'{{ pscInterfaceConfig }}',
'{{ reservedPublicIpConfig }}',
'{{ vpcPeeringConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ privateConnectionId }}',
'{{ requestId }}',
'{{ skipValidation }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: private_connections
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the private_connections resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the private_connections resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The private connection display name.
  - name: labels
    value: "{{ labels }}"
    description: |
      The resource labels for private connections 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: name
    value: "{{ name }}"
    description: |
      The name of the resource.
  - name: pscInterfaceConfig
    description: |
      PSC Interface configuration.
    value:
      networkAttachment: "{{ networkAttachment }}"
  - name: reservedPublicIpConfig
    description: |
      Reserved Public IP configuration.
    value:
      egressPublicIps:
        - "{{ egressPublicIps }}"
      natIpsCount: {{ natIpsCount }}
  - name: vpcPeeringConfig
    description: |
      VPC peering configuration.
    value:
      subnet: "{{ subnet }}"
      vpcName: "{{ vpcName }}"
  - name: privateConnectionId
    value: "{{ privateConnectionId }}"
  - name: requestId
    value: "{{ requestId }}"
  - name: skipValidation
    value: {{ skipValidation }}
  - name: validateOnly
    value: {{ validateOnly }}

DELETE examples

delete

Deletes a single Database Migration Service private connection.

DELETE FROM google.datamigration.private_connections
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateConnectionsId = '{{ privateConnectionsId }}' --required
AND requestId = '{{ requestId }}'
;