1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. vpcaccess
  5. Connector
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

gcp.vpcaccess.Connector

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

    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", {
        name: "vpc-con",
        ipCidrRange: "10.8.0.0/28",
        network: "default",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    connector = gcp.vpcaccess.Connector("connector",
        name="vpc-con",
        ip_cidr_range="10.8.0.0/28",
        network="default")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/vpcaccess"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vpcaccess.NewConnector(ctx, "connector", &vpcaccess.ConnectorArgs{
    			Name:        pulumi.String("vpc-con"),
    			IpCidrRange: pulumi.String("10.8.0.0/28"),
    			Network:     pulumi.String("default"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var connector = new Gcp.VpcAccess.Connector("connector", new()
        {
            Name = "vpc-con",
            IpCidrRange = "10.8.0.0/28",
            Network = "default",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.vpcaccess.Connector;
    import com.pulumi.gcp.vpcaccess.ConnectorArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var connector = new Connector("connector", ConnectorArgs.builder()
                .name("vpc-con")
                .ipCidrRange("10.8.0.0/28")
                .network("default")
                .build());
    
        }
    }
    
    resources:
      connector:
        type: gcp:vpcaccess:Connector
        properties:
          name: vpc-con
          ipCidrRange: 10.8.0.0/28
          network: default
    

    Vpc Access Connector Shared Vpc

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const customTestNetwork = new gcp.compute.Network("custom_test", {
        name: "vpc-con",
        autoCreateSubnetworks: false,
    });
    const customTest = new gcp.compute.Subnetwork("custom_test", {
        name: "vpc-con",
        ipCidrRange: "10.2.0.0/28",
        region: "us-central1",
        network: customTestNetwork.id,
    });
    const connector = new gcp.vpcaccess.Connector("connector", {
        name: "vpc-con",
        subnet: {
            name: customTest.name,
        },
        machineType: "e2-standard-4",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    custom_test_network = gcp.compute.Network("custom_test",
        name="vpc-con",
        auto_create_subnetworks=False)
    custom_test = gcp.compute.Subnetwork("custom_test",
        name="vpc-con",
        ip_cidr_range="10.2.0.0/28",
        region="us-central1",
        network=custom_test_network.id)
    connector = gcp.vpcaccess.Connector("connector",
        name="vpc-con",
        subnet=gcp.vpcaccess.ConnectorSubnetArgs(
            name=custom_test.name,
        ),
        machine_type="e2-standard-4")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/vpcaccess"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		customTestNetwork, err := compute.NewNetwork(ctx, "custom_test", &compute.NetworkArgs{
    			Name:                  pulumi.String("vpc-con"),
    			AutoCreateSubnetworks: pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		customTest, err := compute.NewSubnetwork(ctx, "custom_test", &compute.SubnetworkArgs{
    			Name:        pulumi.String("vpc-con"),
    			IpCidrRange: pulumi.String("10.2.0.0/28"),
    			Region:      pulumi.String("us-central1"),
    			Network:     customTestNetwork.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = vpcaccess.NewConnector(ctx, "connector", &vpcaccess.ConnectorArgs{
    			Name: pulumi.String("vpc-con"),
    			Subnet: &vpcaccess.ConnectorSubnetArgs{
    				Name: customTest.Name,
    			},
    			MachineType: pulumi.String("e2-standard-4"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var customTestNetwork = new Gcp.Compute.Network("custom_test", new()
        {
            Name = "vpc-con",
            AutoCreateSubnetworks = false,
        });
    
        var customTest = new Gcp.Compute.Subnetwork("custom_test", new()
        {
            Name = "vpc-con",
            IpCidrRange = "10.2.0.0/28",
            Region = "us-central1",
            Network = customTestNetwork.Id,
        });
    
        var connector = new Gcp.VpcAccess.Connector("connector", new()
        {
            Name = "vpc-con",
            Subnet = new Gcp.VpcAccess.Inputs.ConnectorSubnetArgs
            {
                Name = customTest.Name,
            },
            MachineType = "e2-standard-4",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.compute.Network;
    import com.pulumi.gcp.compute.NetworkArgs;
    import com.pulumi.gcp.compute.Subnetwork;
    import com.pulumi.gcp.compute.SubnetworkArgs;
    import com.pulumi.gcp.vpcaccess.Connector;
    import com.pulumi.gcp.vpcaccess.ConnectorArgs;
    import com.pulumi.gcp.vpcaccess.inputs.ConnectorSubnetArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var customTestNetwork = new Network("customTestNetwork", NetworkArgs.builder()
                .name("vpc-con")
                .autoCreateSubnetworks(false)
                .build());
    
            var customTest = new Subnetwork("customTest", SubnetworkArgs.builder()
                .name("vpc-con")
                .ipCidrRange("10.2.0.0/28")
                .region("us-central1")
                .network(customTestNetwork.id())
                .build());
    
            var connector = new Connector("connector", ConnectorArgs.builder()
                .name("vpc-con")
                .subnet(ConnectorSubnetArgs.builder()
                    .name(customTest.name())
                    .build())
                .machineType("e2-standard-4")
                .build());
    
        }
    }
    
    resources:
      connector:
        type: gcp:vpcaccess:Connector
        properties:
          name: vpc-con
          subnet:
            name: ${customTest.name}
          machineType: e2-standard-4
      customTest:
        type: gcp:compute:Subnetwork
        name: custom_test
        properties:
          name: vpc-con
          ipCidrRange: 10.2.0.0/28
          region: us-central1
          network: ${customTestNetwork.id}
      customTestNetwork:
        type: gcp:compute:Network
        name: custom_test
        properties:
          name: vpc-con
          autoCreateSubnetworks: false
    

    Create Connector Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Connector(name: string, args?: ConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def Connector(resource_name: str,
                  args: Optional[ConnectorArgs] = None,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Connector(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  ip_cidr_range: Optional[str] = None,
                  machine_type: Optional[str] = None,
                  max_instances: Optional[int] = None,
                  max_throughput: Optional[int] = None,
                  min_instances: Optional[int] = None,
                  min_throughput: Optional[int] = None,
                  name: Optional[str] = None,
                  network: Optional[str] = None,
                  project: Optional[str] = None,
                  region: Optional[str] = None,
                  subnet: Optional[ConnectorSubnetArgs] = None)
    func NewConnector(ctx *Context, name string, args *ConnectorArgs, opts ...ResourceOption) (*Connector, error)
    public Connector(string name, ConnectorArgs? args = null, CustomResourceOptions? opts = null)
    public Connector(String name, ConnectorArgs args)
    public Connector(String name, ConnectorArgs args, CustomResourceOptions options)
    
    type: gcp:vpcaccess:Connector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var connectorResource = new Gcp.VpcAccess.Connector("connectorResource", new()
    {
        IpCidrRange = "string",
        MachineType = "string",
        MaxInstances = 0,
        MaxThroughput = 0,
        MinInstances = 0,
        MinThroughput = 0,
        Name = "string",
        Network = "string",
        Project = "string",
        Region = "string",
        Subnet = new Gcp.VpcAccess.Inputs.ConnectorSubnetArgs
        {
            Name = "string",
            ProjectId = "string",
        },
    });
    
    example, err := vpcaccess.NewConnector(ctx, "connectorResource", &vpcaccess.ConnectorArgs{
    	IpCidrRange:   pulumi.String("string"),
    	MachineType:   pulumi.String("string"),
    	MaxInstances:  pulumi.Int(0),
    	MaxThroughput: pulumi.Int(0),
    	MinInstances:  pulumi.Int(0),
    	MinThroughput: pulumi.Int(0),
    	Name:          pulumi.String("string"),
    	Network:       pulumi.String("string"),
    	Project:       pulumi.String("string"),
    	Region:        pulumi.String("string"),
    	Subnet: &vpcaccess.ConnectorSubnetArgs{
    		Name:      pulumi.String("string"),
    		ProjectId: pulumi.String("string"),
    	},
    })
    
    var connectorResource = new Connector("connectorResource", ConnectorArgs.builder()
        .ipCidrRange("string")
        .machineType("string")
        .maxInstances(0)
        .maxThroughput(0)
        .minInstances(0)
        .minThroughput(0)
        .name("string")
        .network("string")
        .project("string")
        .region("string")
        .subnet(ConnectorSubnetArgs.builder()
            .name("string")
            .projectId("string")
            .build())
        .build());
    
    connector_resource = gcp.vpcaccess.Connector("connectorResource",
        ip_cidr_range="string",
        machine_type="string",
        max_instances=0,
        max_throughput=0,
        min_instances=0,
        min_throughput=0,
        name="string",
        network="string",
        project="string",
        region="string",
        subnet=gcp.vpcaccess.ConnectorSubnetArgs(
            name="string",
            project_id="string",
        ))
    
    const connectorResource = new gcp.vpcaccess.Connector("connectorResource", {
        ipCidrRange: "string",
        machineType: "string",
        maxInstances: 0,
        maxThroughput: 0,
        minInstances: 0,
        minThroughput: 0,
        name: "string",
        network: "string",
        project: "string",
        region: "string",
        subnet: {
            name: "string",
            projectId: "string",
        },
    });
    
    type: gcp:vpcaccess:Connector
    properties:
        ipCidrRange: string
        machineType: string
        maxInstances: 0
        maxThroughput: 0
        minInstances: 0
        minThroughput: 0
        name: string
        network: string
        project: string
        region: string
        subnet:
            name: string
            projectId: string
    

    Connector Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Connector resource accepts the following input properties:

    IpCidrRange string
    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 int
    Maximum value of instances in autoscaling group underlying the connector. Value must be between 3 and 10, inclusive. Must be higher than the value specified by min_instances.
    MaxThroughput int
    Maximum throughput of the connector in Mbps, must be greater than min_throughput. Default is 300. 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 int
    Minimum value of instances in autoscaling group underlying the connector. Value must be between 2 and 9, inclusive. Must be lower than the value specified by max_instances.
    MinThroughput int
    Minimum throughput of the connector in Mbps. Default and min is 200. 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.
    Name string
    The name of the resource (Max 25 characters).


    Network string
    Name or self_link of the VPC network. Required if ip_cidr_range is set.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    Region where the VPC Access connector resides. If it is not provided, the provider region is used.
    Subnet ConnectorSubnet
    The subnet in which to house the connector Structure is documented below.
    IpCidrRange string
    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 int
    Maximum value of instances in autoscaling group underlying the connector. Value must be between 3 and 10, inclusive. Must be higher than the value specified by min_instances.
    MaxThroughput int
    Maximum throughput of the connector in Mbps, must be greater than min_throughput. Default is 300. 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 int
    Minimum value of instances in autoscaling group underlying the connector. Value must be between 2 and 9, inclusive. Must be lower than the value specified by max_instances.
    MinThroughput int
    Minimum throughput of the connector in Mbps. Default and min is 200. 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.
    Name string
    The name of the resource (Max 25 characters).


    Network string
    Name or self_link of the VPC network. Required if ip_cidr_range is set.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    Region where the VPC Access connector resides. If it is not provided, the provider region is used.
    Subnet ConnectorSubnetArgs
    The subnet in which to house the connector Structure is documented below.
    ipCidrRange String
    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. Value must be between 3 and 10, inclusive. Must be higher than the value specified by min_instances.
    maxThroughput Integer
    Maximum throughput of the connector in Mbps, must be greater than min_throughput. Default is 300. 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. Value must be between 2 and 9, inclusive. Must be lower than the value specified by max_instances.
    minThroughput Integer
    Minimum throughput of the connector in Mbps. Default and min is 200. 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.
    name String
    The name of the resource (Max 25 characters).


    network String
    Name or self_link of the VPC network. Required if ip_cidr_range is set.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    Region where the VPC Access connector resides. If it is not provided, the provider region is used.
    subnet ConnectorSubnet
    The subnet in which to house the connector Structure is documented below.
    ipCidrRange string
    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 number
    Maximum value of instances in autoscaling group underlying the connector. Value must be between 3 and 10, inclusive. Must be higher than the value specified by min_instances.
    maxThroughput number
    Maximum throughput of the connector in Mbps, must be greater than min_throughput. Default is 300. 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 number
    Minimum value of instances in autoscaling group underlying the connector. Value must be between 2 and 9, inclusive. Must be lower than the value specified by max_instances.
    minThroughput number
    Minimum throughput of the connector in Mbps. Default and min is 200. 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.
    name string
    The name of the resource (Max 25 characters).


    network string
    Name or self_link of the VPC network. Required if ip_cidr_range is set.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region string
    Region where the VPC Access connector resides. If it is not provided, the provider region is used.
    subnet ConnectorSubnet
    The subnet in which to house the connector Structure is documented below.
    ip_cidr_range str
    The range of internal addresses that follows RFC 4632 notation. Example: 10.132.0.0/28.
    machine_type str
    Machine type of VM Instance underlying connector. Default is e2-micro
    max_instances int
    Maximum value of instances in autoscaling group underlying the connector. Value must be between 3 and 10, inclusive. Must be higher than the value specified by min_instances.
    max_throughput int
    Maximum throughput of the connector in Mbps, must be greater than min_throughput. Default is 300. 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.
    min_instances int
    Minimum value of instances in autoscaling group underlying the connector. Value must be between 2 and 9, inclusive. Must be lower than the value specified by max_instances.
    min_throughput int
    Minimum throughput of the connector in Mbps. Default and min is 200. 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.
    name str
    The name of the resource (Max 25 characters).


    network str
    Name or self_link of the VPC network. Required if ip_cidr_range is set.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region str
    Region where the VPC Access connector resides. If it is not provided, the provider region is used.
    subnet ConnectorSubnetArgs
    The subnet in which to house the connector Structure is documented below.
    ipCidrRange String
    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 Number
    Maximum value of instances in autoscaling group underlying the connector. Value must be between 3 and 10, inclusive. Must be higher than the value specified by min_instances.
    maxThroughput Number
    Maximum throughput of the connector in Mbps, must be greater than min_throughput. Default is 300. 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 Number
    Minimum value of instances in autoscaling group underlying the connector. Value must be between 2 and 9, inclusive. Must be lower than the value specified by max_instances.
    minThroughput Number
    Minimum throughput of the connector in Mbps. Default and min is 200. 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.
    name String
    The name of the resource (Max 25 characters).


    network String
    Name or self_link of the VPC network. Required if ip_cidr_range is set.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    Region where the VPC Access connector resides. If it is not provided, the provider region is used.
    subnet Property Map
    The subnet in which to house the connector Structure is documented below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Connector resource produces the following output properties:

    ConnectedProjects List<string>
    List of projects using the connector.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLink string
    The fully qualified name of this VPC connector
    State string
    State of the VPC access connector.
    ConnectedProjects []string
    List of projects using the connector.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLink string
    The fully qualified name of this VPC connector
    State string
    State of the VPC access connector.
    connectedProjects List<String>
    List of projects using the connector.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLink String
    The fully qualified name of this VPC connector
    state String
    State of the VPC access connector.
    connectedProjects string[]
    List of projects using the connector.
    id string
    The provider-assigned unique ID for this managed resource.
    selfLink string
    The fully qualified name of this VPC connector
    state string
    State of the VPC access connector.
    connected_projects Sequence[str]
    List of projects using the connector.
    id str
    The provider-assigned unique ID for this managed resource.
    self_link str
    The fully qualified name of this VPC connector
    state str
    State of the VPC access connector.
    connectedProjects List<String>
    List of projects using the connector.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLink String
    The fully qualified name of this VPC connector
    state String
    State of the VPC access connector.

    Look up Existing Connector Resource

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

    public static get(name: string, id: Input<ID>, state?: ConnectorState, opts?: CustomResourceOptions): Connector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            connected_projects: Optional[Sequence[str]] = None,
            ip_cidr_range: Optional[str] = None,
            machine_type: Optional[str] = None,
            max_instances: Optional[int] = None,
            max_throughput: Optional[int] = None,
            min_instances: Optional[int] = None,
            min_throughput: Optional[int] = None,
            name: Optional[str] = None,
            network: Optional[str] = None,
            project: Optional[str] = None,
            region: Optional[str] = None,
            self_link: Optional[str] = None,
            state: Optional[str] = None,
            subnet: Optional[ConnectorSubnetArgs] = None) -> Connector
    func GetConnector(ctx *Context, name string, id IDInput, state *ConnectorState, opts ...ResourceOption) (*Connector, error)
    public static Connector Get(string name, Input<string> id, ConnectorState? state, CustomResourceOptions? opts = null)
    public static Connector get(String name, Output<String> id, ConnectorState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ConnectedProjects List<string>
    List of projects using the connector.
    IpCidrRange string
    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 int
    Maximum value of instances in autoscaling group underlying the connector. Value must be between 3 and 10, inclusive. Must be higher than the value specified by min_instances.
    MaxThroughput int
    Maximum throughput of the connector in Mbps, must be greater than min_throughput. Default is 300. 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 int
    Minimum value of instances in autoscaling group underlying the connector. Value must be between 2 and 9, inclusive. Must be lower than the value specified by max_instances.
    MinThroughput int
    Minimum throughput of the connector in Mbps. Default and min is 200. 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.
    Name string
    The name of the resource (Max 25 characters).


    Network string
    Name or self_link of the VPC network. Required if ip_cidr_range is set.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    Region where the VPC Access connector resides. If it is not provided, the provider region is used.
    SelfLink string
    The fully qualified name of this VPC connector
    State string
    State of the VPC access connector.
    Subnet ConnectorSubnet
    The subnet in which to house the connector Structure is documented below.
    ConnectedProjects []string
    List of projects using the connector.
    IpCidrRange string
    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 int
    Maximum value of instances in autoscaling group underlying the connector. Value must be between 3 and 10, inclusive. Must be higher than the value specified by min_instances.
    MaxThroughput int
    Maximum throughput of the connector in Mbps, must be greater than min_throughput. Default is 300. 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 int
    Minimum value of instances in autoscaling group underlying the connector. Value must be between 2 and 9, inclusive. Must be lower than the value specified by max_instances.
    MinThroughput int
    Minimum throughput of the connector in Mbps. Default and min is 200. 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.
    Name string
    The name of the resource (Max 25 characters).


    Network string
    Name or self_link of the VPC network. Required if ip_cidr_range is set.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    Region where the VPC Access connector resides. If it is not provided, the provider region is used.
    SelfLink string
    The fully qualified name of this VPC connector
    State string
    State of the VPC access connector.
    Subnet ConnectorSubnetArgs
    The subnet in which to house the connector Structure is documented below.
    connectedProjects List<String>
    List of projects using the connector.
    ipCidrRange String
    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. Value must be between 3 and 10, inclusive. Must be higher than the value specified by min_instances.
    maxThroughput Integer
    Maximum throughput of the connector in Mbps, must be greater than min_throughput. Default is 300. 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. Value must be between 2 and 9, inclusive. Must be lower than the value specified by max_instances.
    minThroughput Integer
    Minimum throughput of the connector in Mbps. Default and min is 200. 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.
    name String
    The name of the resource (Max 25 characters).


    network String
    Name or self_link of the VPC network. Required if ip_cidr_range is set.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    Region where the VPC Access connector resides. If it is not provided, the provider region is used.
    selfLink String
    The fully qualified name of this VPC connector
    state String
    State of the VPC access connector.
    subnet ConnectorSubnet
    The subnet in which to house the connector Structure is documented below.
    connectedProjects string[]
    List of projects using the connector.
    ipCidrRange string
    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 number
    Maximum value of instances in autoscaling group underlying the connector. Value must be between 3 and 10, inclusive. Must be higher than the value specified by min_instances.
    maxThroughput number
    Maximum throughput of the connector in Mbps, must be greater than min_throughput. Default is 300. 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 number
    Minimum value of instances in autoscaling group underlying the connector. Value must be between 2 and 9, inclusive. Must be lower than the value specified by max_instances.
    minThroughput number
    Minimum throughput of the connector in Mbps. Default and min is 200. 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.
    name string
    The name of the resource (Max 25 characters).


    network string
    Name or self_link of the VPC network. Required if ip_cidr_range is set.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region string
    Region where the VPC Access connector resides. If it is not provided, the provider region is used.
    selfLink string
    The fully qualified name of this VPC connector
    state string
    State of the VPC access connector.
    subnet ConnectorSubnet
    The subnet in which to house the connector Structure is documented below.
    connected_projects Sequence[str]
    List of projects using the connector.
    ip_cidr_range str
    The range of internal addresses that follows RFC 4632 notation. Example: 10.132.0.0/28.
    machine_type str
    Machine type of VM Instance underlying connector. Default is e2-micro
    max_instances int
    Maximum value of instances in autoscaling group underlying the connector. Value must be between 3 and 10, inclusive. Must be higher than the value specified by min_instances.
    max_throughput int
    Maximum throughput of the connector in Mbps, must be greater than min_throughput. Default is 300. 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.
    min_instances int
    Minimum value of instances in autoscaling group underlying the connector. Value must be between 2 and 9, inclusive. Must be lower than the value specified by max_instances.
    min_throughput int
    Minimum throughput of the connector in Mbps. Default and min is 200. 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.
    name str
    The name of the resource (Max 25 characters).


    network str
    Name or self_link of the VPC network. Required if ip_cidr_range is set.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region str
    Region where the VPC Access connector resides. If it is not provided, the provider region is used.
    self_link str
    The fully qualified name of this VPC connector
    state str
    State of the VPC access connector.
    subnet ConnectorSubnetArgs
    The subnet in which to house the connector Structure is documented below.
    connectedProjects List<String>
    List of projects using the connector.
    ipCidrRange String
    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 Number
    Maximum value of instances in autoscaling group underlying the connector. Value must be between 3 and 10, inclusive. Must be higher than the value specified by min_instances.
    maxThroughput Number
    Maximum throughput of the connector in Mbps, must be greater than min_throughput. Default is 300. 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 Number
    Minimum value of instances in autoscaling group underlying the connector. Value must be between 2 and 9, inclusive. Must be lower than the value specified by max_instances.
    minThroughput Number
    Minimum throughput of the connector in Mbps. Default and min is 200. 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.
    name String
    The name of the resource (Max 25 characters).


    network String
    Name or self_link of the VPC network. Required if ip_cidr_range is set.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    Region where the VPC Access connector resides. If it is not provided, the provider region is used.
    selfLink String
    The fully qualified name of this VPC connector
    state String
    State of the VPC access connector.
    subnet Property Map
    The subnet in which to house the connector Structure is documented below.

    Supporting Types

    ConnectorSubnet, ConnectorSubnetArgs

    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.
    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.
    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.
    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.
    name str
    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}"
    project_id str
    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.
    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.

    Import

    Connector can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{region}}/connectors/{{name}}

    • {{project}}/{{region}}/{{name}}

    • {{region}}/{{name}}

    • {{name}}

    When using the pulumi import command, Connector can be imported using one of the formats above. For example:

    $ pulumi import gcp:vpcaccess/connector:Connector default projects/{{project}}/locations/{{region}}/connectors/{{name}}
    
    $ pulumi import gcp:vpcaccess/connector:Connector default {{project}}/{{region}}/{{name}}
    
    $ pulumi import gcp:vpcaccess/connector:Connector default {{region}}/{{name}}
    
    $ pulumi import gcp:vpcaccess/connector:Connector default {{name}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi