REST Resource: projects.locations.connectors

Resource: Connector

Definition of a Serverless VPC Access connector.

JSON representation
{
  "name": string,
  "network": string,
  "ipCidrRange": string,
  "state": enum (State),
  "minThroughput": integer,
  "maxThroughput": integer,
  "connectedProjects": [
    string
  ],
  "subnet": {
    object (Subnet)
  },
  "machineType": string,
  "minInstances": integer,
  "maxInstances": integer
}
Fields
name

string

The resource name in the format projects/*/locations/*/connectors/*.

network

string

Name of a VPC network.

ipCidrRange

string

The range of internal addresses that follows RFC 4632 notation. Example: 10.132.0.0/28.

state

enum (State)

Output only. State of the VPC access connector.

minThroughput

integer

Minimum throughput of the connector in Mbps. Default and min is 200. If both min-throughput and min-instances are provided, min-instances takes precedence over min-throughput.

maxThroughput

integer

Maximum throughput of the connector in Mbps. Default is 300, max is 1000. If both max-throughput and max-instances are provided, max-instances takes precedence over max-throughput.

connectedProjects[]

string

Output only. List of projects using the connector.

subnet

object (Subnet)

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

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

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

create

Creates a Serverless VPC Access connector, returns an operation.

delete

Deletes a Serverless VPC Access connector.

get

Gets a Serverless VPC Access connector.

list

Lists Serverless VPC Access connectors.

patch

Updates a Serverless VPC Access connector, returns an operation.