# REST Resource: projects.locations.connectors

- [Resource: Connector](https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors#Connector)
  - [JSON representation](https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors#Connector.SCHEMA_REPRESENTATION)
- [State](https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors#State)
- [Subnet](https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors#Subnet)
  - [JSON representation](https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors#Subnet.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors#METHODS_SUMMARY)

## Resource: Connector

Definition of a Serverless VPC Access connector.

| JSON representation |
|---|
| ``` { "name": string, "network": string, "ipCidrRange": string, "state": enum (`https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors#State`), "minThroughput": integer, "maxThroughput": integer, "connectedProjects": [ string ], "subnet": { object (`https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors#Subnet`) }, "machineType": string, "minInstances": integer, "maxInstances": integer } ``` |

| Fields ||
|---|---|
| `name` | `string` The resource name in the format `projects/*/locations/*/connectors/*`. |
| `network` | `string` Optional. Name of a VPC network. |
| `ipCidrRange` | `string` Optional. The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`. |
| `state` | ``enum (`https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors#State`)`` Output only. State of the VPC access connector. |
| `minThroughput (deprecated)` | `integer` > [!WARNING] > This item is deprecated! 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`. |
| `maxThroughput (deprecated)` | `integer` > [!WARNING] > This item is deprecated! 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`. |
| `connectedProjects[]` | `string` Output only. List of projects using the connector. |
| `subnet` | ``object (`https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors#Subnet`)`` Optional. The subnet in which to house the VPC Access Connector. |
| `machineType` | `string` Machine type of VM Instance underlying connector. Default is e2-micro |
| `minInstances` | `integer` Minimum value of instances in autoscaling group underlying the connector. |
| `maxInstances` | `integer` Maximum value of instances in autoscaling group underlying the connector. |

## State

State of a connector.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Invalid state. |
| `READY` | Connector is deployed and ready to receive traffic. |
| `CREATING` | An Insert operation is in progress. Transient condition. |
| `DELETING` | A Delete operation is in progress. Transient condition. |
| `ERROR` | Connector is in a bad state, manual deletion recommended. |
| `UPDATING` | The connector is being updated. |

## Subnet

The subnet in which to house the connector

| JSON representation |
|---|
| ``` { "name": string, "projectId": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Optional. Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is <https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetName>} the correct input for this field would be {subnetName} |
| `projectId` | `string` Optional. Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors/create` | Creates a Serverless VPC Access connector, returns an operation. |
| ### `https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors/delete` | Deletes a Serverless VPC Access connector. |
| ### `https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors/get` | Gets a Serverless VPC Access connector. |
| ### `https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors/list` | Lists Serverless VPC Access connectors. |
| ### `https://docs.cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors/patch` | Updates a Serverless VPC Access connector, returns an operation. |