REST Resource: projects.locations.privateConnections

Resource: PrivateConnection

The PrivateConnection resource is used to establish private connectivity with the customer's network.

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

  // Union field connectivity can be only one of the following:
  "vpcPeeringConfig": {
    object (VpcPeeringConfig)
  },
  "pscInterfaceConfig": {
    object (PscInterfaceConfig)
  }
  // End of list of possible types for union field connectivity.
}
Fields
name

string

The name of the resource.
createTime

string (Timestamp format)

Output only. The create time of the resource.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The last update time of the resource.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

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" }.

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

string

The private connection display name.
state

enum (State)

Output only. The state of the private connection.
error

object (Status)

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

boolean

Output only. Reserved for future use.
satisfiesPzi

boolean

Output only. Reserved for future use.

Union field connectivity.

connectivity can be only one of the following:
vpcPeeringConfig

object (VpcPeeringConfig)

VPC peering configuration.
pscInterfaceConfig

object (PscInterfaceConfig)

PSC Interface configuration.

State

Private Connection state.

Enums
STATE_UNSPECIFIED
CREATING The private connection is in creation state - creating resources.
CREATED The private connection has been created with all of its resources.
FAILED The private connection creation has failed.
DELETING The private connection is being deleted.
FAILED_TO_DELETE Delete request has failed, resource is in invalid state.
DELETED The private connection has been deleted.

VpcPeeringConfig

The VPC peering configuration is used to create VPC peering with the consumer's VPC.

JSON representation 
{
  "vpcName": string,
  "subnet": string
}
Fields
vpcName

string

Required. Fully qualified name of the VPC that Database Migration Service will peer to.
subnet

string

Required. A free subnet for peering. (CIDR of /29)

PscInterfaceConfig

The PSC Interface configuration is used to create PSC Interface between DMS's internal VPC and the consumer's PSC.

JSON representation 
{
  "networkAttachment": string
}
Fields
networkAttachment

string

Required. Fully qualified name of the Network Attachment that DMS will connect to. Format: projects/{project}/regions/{region}/networkAttachments/{name}

Methods

create

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

delete

 Deletes a single Database Migration Service private connection.

get

 Gets details of a single private connection.

getIamPolicy

 Gets the access control policy for a resource.

list

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

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.