connectors

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

Overview

Name	`connectors`
Type	Resource
Id	`google.vpcaccess.connectors`

Fields

The following fields are returned by SELECT queries:

get
list

Successful response

Name	Datatype	Description
`name`	`string`	The resource name in the format `projects//locations//connectors/*`.
`connectedProjects`	`array`	Output only. List of projects using the connector.
`ipCidrRange`	`string`	Optional. The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`.
`machineType`	`string`	Machine type of VM Instance underlying connector. Default is e2-micro
`maxInstances`	`integer (int32)`	Maximum value of instances in autoscaling group underlying the connector.
`maxThroughput`	`integer (int32)`	Maximum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 300 through 1000. Must be higher than the value specified by --min-throughput. If both max-throughput and max-instances are provided, max-instances takes precedence over max-throughput. The use of `max-throughput` is discouraged in favor of `max-instances`.
`minInstances`	`integer (int32)`	Minimum value of instances in autoscaling group underlying the connector.
`minThroughput`	`integer (int32)`	Minimum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 200 through 900. Must be lower than the value specified by --max-throughput. If both min-throughput and min-instances are provided, min-instances takes precedence over min-throughput. The use of `min-throughput` is discouraged in favor of `min-instances`.
`network`	`string`	Optional. Name of a VPC network.
`state`	`string`	Output only. State of the VPC access connector.
`subnet`	`object`	Optional. The subnet in which to house the VPC Access Connector. (id: Subnet)

Successful response

Name	Datatype	Description
`name`	`string`	The resource name in the format `projects//locations//connectors/*`.
`connectedProjects`	`array`	Output only. List of projects using the connector.
`ipCidrRange`	`string`	Optional. The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`.
`machineType`	`string`	Machine type of VM Instance underlying connector. Default is e2-micro
`maxInstances`	`integer (int32)`	Maximum value of instances in autoscaling group underlying the connector.
`maxThroughput`	`integer (int32)`	Maximum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 300 through 1000. Must be higher than the value specified by --min-throughput. If both max-throughput and max-instances are provided, max-instances takes precedence over max-throughput. The use of `max-throughput` is discouraged in favor of `max-instances`.
`minInstances`	`integer (int32)`	Minimum value of instances in autoscaling group underlying the connector.
`minThroughput`	`integer (int32)`	Minimum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 200 through 900. Must be lower than the value specified by --max-throughput. If both min-throughput and min-instances are provided, min-instances takes precedence over min-throughput. The use of `min-throughput` is discouraged in favor of `min-instances`.
`network`	`string`	Optional. Name of a VPC network.
`state`	`string`	Output only. State of the VPC access connector.
`subnet`	`object`	Optional. The subnet in which to house the VPC Access Connector. (id: Subnet)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `connectorsId`		Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.
`list`	`select`	`projectsId`, `locationsId`	`pageSize`, `pageToken`	Lists Serverless VPC Access connectors.
`create`	`insert`	`projectsId`, `locationsId`	`connectorId`	Creates a Serverless VPC Access connector, returns an operation.
`patch`	`update`	`projectsId`, `locationsId`, `connectorsId`	`updateMask`	Updates a Serverless VPC Access connector, returns an operation.
`delete`	`delete`	`projectsId`, `locationsId`, `connectorsId`		Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

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
`connectorsId`	`string`
`locationsId`	`string`
`projectsId`	`string`
`connectorId`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

get
list

Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

SELECT
name,
connectedProjects,
ipCidrRange,
machineType,
maxInstances,
maxThroughput,
minInstances,
minThroughput,
network,
state,
subnet
FROM google.vpcaccess.connectors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND connectorsId = '{{ connectorsId }}' -- required;

Lists Serverless VPC Access connectors.

SELECT
name,
connectedProjects,
ipCidrRange,
machineType,
maxInstances,
maxThroughput,
minInstances,
minThroughput,
network,
state,
subnet
FROM google.vpcaccess.connectors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

`INSERT` examples

create
Manifest

Creates a Serverless VPC Access connector, returns an operation.

INSERT INTO google.vpcaccess.connectors (
data__name,
data__network,
data__ipCidrRange,
data__minThroughput,
data__maxThroughput,
data__subnet,
data__machineType,
data__minInstances,
data__maxInstances,
projectsId,
locationsId,
connectorId
)
SELECT 
'{{ name }}',
'{{ network }}',
'{{ ipCidrRange }}',
{{ minThroughput }},
{{ maxThroughput }},
'{{ subnet }}',
'{{ machineType }}',
{{ minInstances }},
{{ maxInstances }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ connectorId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: connectors
  props:
    - name: projectsId
      value: string
      description: Required parameter for the connectors resource.
    - name: locationsId
      value: string
      description: Required parameter for the connectors resource.
    - name: name
      value: string
      description: >
        The resource name in the format `projects/*/locations/*/connectors/*`.
        
    - name: network
      value: string
      description: >
        Optional. Name of a VPC network.
        
    - name: ipCidrRange
      value: string
      description: >
        Optional. The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`.
        
    - name: minThroughput
      value: integer
      description: >
        Minimum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 200 through 900. Must be lower than the value specified by --max-throughput. If both min-throughput and min-instances are provided, min-instances takes precedence over min-throughput. The use of `min-throughput` is discouraged in favor of `min-instances`.
        
    - name: maxThroughput
      value: integer
      description: >
        Maximum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 300 through 1000. Must be higher than the value specified by --min-throughput. If both max-throughput and max-instances are provided, max-instances takes precedence over max-throughput. The use of `max-throughput` is discouraged in favor of `max-instances`.
        
    - name: subnet
      value: object
      description: >
        Optional. The subnet in which to house the VPC Access Connector.
        
    - name: machineType
      value: string
      description: >
        Machine type of VM Instance underlying connector. Default is e2-micro
        
    - name: minInstances
      value: integer
      description: >
        Minimum value of instances in autoscaling group underlying the connector.
        
    - name: maxInstances
      value: integer
      description: >
        Maximum value of instances in autoscaling group underlying the connector.
        
    - name: connectorId
      value: string

`UPDATE` examples

patch

Updates a Serverless VPC Access connector, returns an operation.

UPDATE google.vpcaccess.connectors
SET 
data__name = '{{ name }}',
data__network = '{{ network }}',
data__ipCidrRange = '{{ ipCidrRange }}',
data__minThroughput = {{ minThroughput }},
data__maxThroughput = {{ maxThroughput }},
data__subnet = '{{ subnet }}',
data__machineType = '{{ machineType }}',
data__minInstances = {{ minInstances }},
data__maxInstances = {{ maxInstances }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND connectorsId = '{{ connectorsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

delete

Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

DELETE FROM google.vpcaccess.connectors
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND connectorsId = '{{ connectorsId }}' --required;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​