connections

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

Overview

Name	connections
Type	Resource
Id	google.servicenetworking.connections

Fields

The following fields are returned by SELECT queries:

list

Successful response

Name	Datatype	Description
connections	array	The list of Connections.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	servicesId	network	List the private connections that are configured in a service consumer's VPC network.
create	insert	servicesId		Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization. The administrator of the service consumer's VPC network invokes this method. The administrator must assign one or more allocated IP ranges for provisioning subnetworks in the service producer's VPC network. This connection is used for all supported services in the service producer's organization, so it only needs to be invoked once.
patch	update	servicesId, connectionsId	updateMask, force	Updates the allocated ranges that are assigned to a 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
connectionsId	string
servicesId	string
force	boolean
network	string
updateMask	string (google-fieldmask)

SELECT examples

list

List the private connections that are configured in a service consumer's VPC network.

SELECT
connections
FROM google.servicenetworking.connections
WHERE servicesId = '{{ servicesId }}' -- required
AND network = '{{ network }}';

INSERT examples

create

Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization. The administrator of the service consumer's VPC network invokes this method. The administrator must assign one or more allocated IP ranges for provisioning subnetworks in the service producer's VPC network. This connection is used for all supported services in the service producer's organization, so it only needs to be invoked once.

INSERT INTO google.servicenetworking.connections (
data__network,
data__reservedPeeringRanges,
servicesId
)
SELECT 
'{{ network }}',
'{{ reservedPeeringRanges }}',
'{{ servicesId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: connections
  props:
    - name: servicesId
      value: string
      description: Required parameter for the connections resource.
    - name: network
      value: string
      description: >
        Required. The name of service consumer's VPC network that's connected with service producer network, in the following format: `projects/{project}/global/networks/{network}`. `{project}` is a project number, such as in `12345` that includes the VPC service consumer's VPC network. `{network}` is the name of the service consumer's VPC network.
        
    - name: reservedPeeringRanges
      value: array
      description: >
        The name of one or more allocated IP address ranges for this service producer of type `PEERING`. Note that invoking CreateConnection method with a different range when connection is already established will not modify already provisioned service producer subnetworks. If CreateConnection method is invoked repeatedly to reconnect when peering connection had been disconnected on the consumer side, leaving this field empty will restore previously allocated IP ranges.
        

UPDATE examples

patch

Updates the allocated ranges that are assigned to a connection.

UPDATE google.servicenetworking.connections
SET 
data__network = '{{ network }}',
data__reservedPeeringRanges = '{{ reservedPeeringRanges }}'
WHERE 
servicesId = '{{ servicesId }}' --required
AND connectionsId = '{{ connectionsId }}' --required
AND updateMask = '{{ updateMask}}'
AND force = {{ force}}
RETURNING
name,
done,
error,
metadata,
response;