VPCAccessConnector

Property Value
Google Cloud Service Name Serverless VPC Access
Google Cloud Service Documentation /vpc/docs/
Google Cloud REST Resource Name v1beta1.projects.locations.connectors
Google Cloud REST Resource Documentation /vpc/docs/reference/vpcaccess/rest/v1beta1/projects.locations.connectors
Config Connector Resource Short Names gcpvpcaccessconnector
gcpvpcaccessconnectors
vpcaccessconnector
Config Connector Service Name vpcaccess.googleapis.com
Config Connector Resource Fully Qualified Name vpcaccessconnectors.vpcaccess.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No

Custom Resource Definition Properties

Spec

Schema

  ipCidrRange: string
  location: string
  machineType: string
  maxInstances: integer
  maxThroughput: integer
  minInstances: integer
  minThroughput: integer
  networkRef:
    external: string
    name: string
    namespace: string
  projectRef:
    external: string
    name: string
    namespace: string
  resourceID: string
  subnet:
    nameRef:
      external: string
      name: string
      namespace: string
    projectRef:
      external: string
      name: string
      namespace: string
Fields

ipCidrRange

Optional

string

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

location

Required

string

Immutable. The location for the resource

machineType

Optional

string

Immutable. Machine type of VM Instance underlying connector. Default is e2-micro

maxInstances

Optional

integer

Immutable. Maximum value of instances in autoscaling group underlying the connector.

maxThroughput

Optional

integer

Immutable. Maximum throughput of the connector in Mbps. Default is 200, max is 1000.

minInstances

Optional

integer

Immutable. Minimum value of instances in autoscaling group underlying the connector.

minThroughput

Optional

integer

Immutable. Minimum throughput of the connector in Mbps. Default and min is 200.

networkRef

Optional

object

Immutable.

networkRef.external

Optional

string

Name of a VPC network. Allowed value: The Google Cloud resource name of a `ComputeNetwork` resource (format: `projects/{{project}}/global/networks/{{name}}`).

networkRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

networkRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

projectRef

Required

object

Immutable. The Project that this resource belongs to.

projectRef.external

Optional

string

The project for the resource Allowed value: The Google Cloud resource name of a `Project` resource (format: `projects/{{name}}`).

projectRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

projectRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceID

Optional

string

Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.

subnet

Optional

object

Immutable. The subnet in which to house the VPC Access Connector.

subnet.nameRef

Optional

object

Immutable.

subnet.nameRef.external

Optional

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} Allowed value: The Google Cloud resource name of a `ComputeSubnetwork` resource (format: `projects/{{project}}/regions/{{region}}/subnetworks/{{name}}`).

subnet.nameRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

subnet.nameRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

subnet.projectRef

Optional

object

Immutable.

subnet.projectRef.external

Optional

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. Allowed value: The Google Cloud resource name of a `Project` resource (format: `projects/{{name}}`).

subnet.projectRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

subnet.projectRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

Status

Schema

  conditions:
  - lastTransitionTime: string
    message: string
    reason: string
    status: string
    type: string
  connectedProjects:
  - string
  observedGeneration: integer
  state: string
Fields
conditions

list (object)

Conditions represent the latest available observation of the resource's current state.

conditions[]

object

conditions[].lastTransitionTime

string

Last time the condition transitioned from one status to another.

conditions[].message

string

Human-readable message indicating details about last transition.

conditions[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.

conditions[].status

string

Status is the status of the condition. Can be True, False, Unknown.

conditions[].type

string

Type is the type of the condition.

connectedProjects

list (string)

Output only. List of projects using the connector.

connectedProjects[]

string

observedGeneration

integer

ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.

state

string

Output only. State of the VPC access connector. Possible values: STATE_UNSPECIFIED, READY, CREATING, DELETING, ERROR, UPDATING

Sample YAML(s)

Cidr Connector

  # Copyright 2021 Google LLC
  #
  # Licensed under the Apache License, Version 2.0 (the "License");
  # you may not use this file except in compliance with the License.
  # You may obtain a copy of the License at
  #
  #     http://www.apache.org/licenses/LICENSE-2.0
  #
  # Unless required by applicable law or agreed to in writing, software
  # distributed under the License is distributed on an "AS IS" BASIS,
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  # See the License for the specific language governing permissions and
  # limitations under the License.
  
  apiVersion: vpcaccess.cnrm.cloud.google.com/v1beta1
  kind: VPCAccessConnector
  metadata:
    name: connector-sample-cidr
  spec:
    location: "us-central1"
    networkRef:
      name: connector-dep-cidr
    ipCidrRange: "10.132.0.0/28"
    minThroughput: 300
    maxThroughput: 400
    projectRef:
      # Replace ${PROJECT_ID?} with your project ID
      external: "projects/${PROJECT_ID?}"
  ---
  apiVersion: compute.cnrm.cloud.google.com/v1beta1
  kind: ComputeNetwork
  metadata:
    name: connector-dep-cidr
  spec:
    autoCreateSubnetworks: false

Subnet Connector

  # Copyright 2021 Google LLC
  #
  # Licensed under the Apache License, Version 2.0 (the "License");
  # you may not use this file except in compliance with the License.
  # You may obtain a copy of the License at
  #
  #     http://www.apache.org/licenses/LICENSE-2.0
  #
  # Unless required by applicable law or agreed to in writing, software
  # distributed under the License is distributed on an "AS IS" BASIS,
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  # See the License for the specific language governing permissions and
  # limitations under the License.
  
  apiVersion: vpcaccess.cnrm.cloud.google.com/v1beta1
  kind: VPCAccessConnector
  metadata:
    name: connector-sample-subnet
  spec:
    location: "us-central1"
    machineType: "e2-micro"
    minInstances: 2
    maxInstances: 3
    subnet:
      nameRef:
        name: connector-dep-subnet
      projectRef:
        # Replace ${PROJECT_ID?} with your project ID.
        external: "projects/${PROJECT_ID?}"
    projectRef:
      # Replace ${PROJECT_ID?} with your project ID
      external: "projects/${PROJECT_ID?}"
  ---
  apiVersion: compute.cnrm.cloud.google.com/v1beta1
  kind: ComputeNetwork
  metadata:
    name: connector-dep-subnet
  spec:
    autoCreateSubnetworks: false
  ---
  apiVersion: compute.cnrm.cloud.google.com/v1beta1
  kind: ComputeSubnetwork
  metadata:
    name: connector-dep-subnet
  spec:
    ipCidrRange: "10.2.0.0/28"
    region: "us-west2"
    networkRef:
      name: connector-dep-subnet