connectors

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

Overview

Name	connectors
Type	Resource
Id	google.vpcaccess.connectors

Fields

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	Maximum value of instances in autoscaling group underlying the connector.
maxThroughput	integer	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	Minimum value of instances in autoscaling group underlying the connector.
minThroughput	integer	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	The subnet in which to house the connector

Methods

Name	Accessible by	Required Params	Description
get	SELECT	connectorsId, locationsId, projectsId	Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.
list	SELECT	locationsId, projectsId	Lists Serverless VPC Access connectors.
create	INSERT	locationsId, projectsId	Creates a Serverless VPC Access connector, returns an operation.
delete	DELETE	connectorsId, locationsId, projectsId	Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.
patch	UPDATE	connectorsId, locationsId, projectsId	Updates a Serverless VPC Access connector, returns an operation.

SELECT examples

Lists Serverless VPC Access connectors.

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

INSERT example

Use the following StackQL query and manifest file to create a new connectors resource.

All Properties

/*+ create */
INSERT INTO google.vpcaccess.connectors (
locationsId,
projectsId,
name,
network,
ipCidrRange,
minThroughput,
maxThroughput,
subnet,
machineType,
minInstances,
maxInstances
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ network }}',
'{{ ipCidrRange }}',
'{{ minThroughput }}',
'{{ maxThroughput }}',
'{{ subnet }}',
'{{ machineType }}',
'{{ minInstances }}',
'{{ maxInstances }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: network
      value: string
    - name: ipCidrRange
      value: string
    - name: state
      value: string
    - name: minThroughput
      value: integer
    - name: maxThroughput
      value: integer
    - name: connectedProjects
      value:
        - string
    - name: subnet
      value:
        - name: name
          value: string
        - name: projectId
          value: string
    - name: machineType
      value: string
    - name: minInstances
      value: integer
    - name: maxInstances
      value: integer

UPDATE example

Updates a connectors resource.

/*+ update */
UPDATE google.vpcaccess.connectors
SET 
name = '{{ name }}',
network = '{{ network }}',
ipCidrRange = '{{ ipCidrRange }}',
minThroughput = '{{ minThroughput }}',
maxThroughput = '{{ maxThroughput }}',
subnet = '{{ subnet }}',
machineType = '{{ machineType }}',
minInstances = '{{ minInstances }}',
maxInstances = '{{ maxInstances }}'
WHERE 
connectorsId = '{{ connectorsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified connectors resource.

/*+ delete */
DELETE FROM google.vpcaccess.connectors
WHERE connectorsId = '{{ connectorsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';