REST Resource: projects.locations.privateConnections

Resource: PrivateConnection

The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "displayName": string,
  "state": enum (State),
  "error": {
    object (Error)
  },
  "vpcPeeringConfig": {
    object (VpcPeeringConfig)
  }
}
Fields
name

string

Output only. The resource's name.

createTime

string (Timestamp format)

Output only. The create time of the resource.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The update time of the resource.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Labels.

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

displayName

string

Required. Display name.

state

enum (State)

Output only. The state of the Private Connection.

error

object (Error)

Output only. In case of error, the details of the error in a user-friendly format.

vpcPeeringConfig

object (VpcPeeringConfig)

VPC Peering Config

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 it's resources.
FAILED The private connection creation has failed.

VpcPeeringConfig

The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC.

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

string

Required. fully qualified name of the VPC Datastream will peer to.

subnet

string

Required. A free subnet for peering. (CIDR of /29) TODO(b/172995841) add validators.

Methods

create

Use this method to create a private connectivity configuration.

delete

Use this method to delete a private connectivity configuration.

get

Use this method to get details about a private connectivity configuration.

list

Use this method to list private connectivity configurations in a project and location.