1. Docs
  2. Reference
  3. API
  4. @pulumi/gcp
  5. vpcaccess

Module vpcaccess

This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Others

Resources

Resource Connector

class Connector extends CustomResource

Serverless VPC Access connector resource.

To get more information about Connector, see:

Example Usage - VPC Access Connector

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const connector = new gcp.vpcaccess.Connector("connector", {
    ipCidrRange: "10.8.0.0/28",
    network: "default",
    region: "us-central1",
});

constructor

new Connector(name: string, args: ConnectorArgs, opts?: pulumi.CustomResourceOptions)

Create a Connector resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConnectorState, opts?: pulumi.CustomResourceOptions): Connector

Get an existing Connector resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Connector

Returns true if the given object is an instance of Connector. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipCidrRange

public ipCidrRange: pulumi.Output<string>;

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

property maxThroughput

public maxThroughput: pulumi.Output<number | undefined>;

Maximum throughput of the connector in Mbps, must be greater than minThroughput. Default is 1000.

property minThroughput

public minThroughput: pulumi.Output<number | undefined>;

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

property name

public name: pulumi.Output<string>;

The name of the resource (Max 25 characters).

property network

public network: pulumi.Output<string>;

Name of a VPC network.

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property region

public region: pulumi.Output<string>;

Region where the VPC Access connector resides

public selfLink: pulumi.Output<string>;

The fully qualified name of this VPC connector

property state

public state: pulumi.Output<string>;

State of the VPC access connector.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface ConnectorArgs

interface ConnectorArgs

The set of arguments for constructing a Connector resource.

property ipCidrRange

ipCidrRange: pulumi.Input<string>;

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

property maxThroughput

maxThroughput?: pulumi.Input<number>;

Maximum throughput of the connector in Mbps, must be greater than minThroughput. Default is 1000.

property minThroughput

minThroughput?: pulumi.Input<number>;

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

property name

name?: pulumi.Input<string>;

The name of the resource (Max 25 characters).

property network

network: pulumi.Input<string>;

Name of a VPC network.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property region

region: pulumi.Input<string>;

Region where the VPC Access connector resides

interface ConnectorState

interface ConnectorState

Input properties used for looking up and filtering Connector resources.

property ipCidrRange

ipCidrRange?: pulumi.Input<string>;

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

property maxThroughput

maxThroughput?: pulumi.Input<number>;

Maximum throughput of the connector in Mbps, must be greater than minThroughput. Default is 1000.

property minThroughput

minThroughput?: pulumi.Input<number>;

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

property name

name?: pulumi.Input<string>;

The name of the resource (Max 25 characters).

property network

network?: pulumi.Input<string>;

Name of a VPC network.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property region

region?: pulumi.Input<string>;

Region where the VPC Access connector resides

selfLink?: pulumi.Input<string>;

The fully qualified name of this VPC connector

property state

state?: pulumi.Input<string>;

State of the VPC access connector.