Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. vpcaccess
  5. vpcaccess/v1
  6. Connector

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.vpcaccess/v1.Connector

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a Serverless VPC Access connector, returns an operation.

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: ConnectorArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Connector(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              connector_id: Optional[str] = None,
              ip_cidr_range: Optional[str] = None,
              location: 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,
              subnet: Optional[SubnetArgs] = None)
func NewConnector(ctx *Context, name string, args ConnectorArgs, opts ...ResourceOption) (*Connector, error)
public Connector(string name, ConnectorArgs args, CustomResourceOptions? opts = null)
public Connector(String name, ConnectorArgs args)
public Connector(String name, ConnectorArgs args, CustomResourceOptions options)

type: google-native:vpcaccess/v1:Connector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ConnectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ConnectorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ConnectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ConnectorArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var google_nativeConnectorResource = new GoogleNative.VPCAccess.V1.Connector("google-nativeConnectorResource", new()
{
    ConnectorId = "string",
    IpCidrRange = "string",
    Location = "string",
    MachineType = "string",
    MaxInstances = 0,
    MaxThroughput = 0,
    MinInstances = 0,
    MinThroughput = 0,
    Name = "string",
    Network = "string",
    Project = "string",
    Subnet = new GoogleNative.VPCAccess.V1.Inputs.SubnetArgs
    {
        Name = "string",
        Project = "string",
    },
});
Copy
example, err := vpcaccess.NewConnector(ctx, "google-nativeConnectorResource", &vpcaccess.ConnectorArgs{
	ConnectorId:   pulumi.String("string"),
	IpCidrRange:   pulumi.String("string"),
	Location:      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"),
	Subnet: &vpcaccess.SubnetArgs{
		Name:    pulumi.String("string"),
		Project: pulumi.String("string"),
	},
})
Copy
var google_nativeConnectorResource = new Connector("google-nativeConnectorResource", ConnectorArgs.builder()
    .connectorId("string")
    .ipCidrRange("string")
    .location("string")
    .machineType("string")
    .maxInstances(0)
    .maxThroughput(0)
    .minInstances(0)
    .minThroughput(0)
    .name("string")
    .network("string")
    .project("string")
    .subnet(SubnetArgs.builder()
        .name("string")
        .project("string")
        .build())
    .build());
Copy
google_native_connector_resource = google_native.vpcaccess.v1.Connector("google-nativeConnectorResource",
    connector_id="string",
    ip_cidr_range="string",
    location="string",
    machine_type="string",
    max_instances=0,
    max_throughput=0,
    min_instances=0,
    min_throughput=0,
    name="string",
    network="string",
    project="string",
    subnet={
        "name": "string",
        "project": "string",
    })
Copy
const google_nativeConnectorResource = new google_native.vpcaccess.v1.Connector("google-nativeConnectorResource", {
    connectorId: "string",
    ipCidrRange: "string",
    location: "string",
    machineType: "string",
    maxInstances: 0,
    maxThroughput: 0,
    minInstances: 0,
    minThroughput: 0,
    name: "string",
    network: "string",
    project: "string",
    subnet: {
        name: "string",
        project: "string",
    },
});
Copy
type: google-native:vpcaccess/v1:Connector
properties:
    connectorId: string
    ipCidrRange: string
    location: string
    machineType: string
    maxInstances: 0
    maxThroughput: 0
    minInstances: 0
    minThroughput: 0
    name: string
    network: string
    project: string
    subnet:
        name: string
        project: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Connector resource accepts the following input properties:

ConnectorId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for this connector.
IpCidrRange string
The range of internal addresses that follows RFC 4632 notation. Example: 10.132.0.0/28.
Location Changes to this property will trigger replacement. string
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.
MaxThroughput int
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.
MinInstances int
Minimum value of instances in autoscaling group underlying the connector.
MinThroughput int
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.
Name string
The resource name in the format projects/*/locations/*/connectors/*.
Network string
Name of a VPC network.
Project Changes to this property will trigger replacement. string
Subnet Pulumi.GoogleNative.VPCAccess.V1.Inputs.Subnet
The subnet in which to house the VPC Access Connector.
ConnectorId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for this connector.
IpCidrRange string
The range of internal addresses that follows RFC 4632 notation. Example: 10.132.0.0/28.
Location Changes to this property will trigger replacement. string
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.
MaxThroughput int
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.
MinInstances int
Minimum value of instances in autoscaling group underlying the connector.
MinThroughput int
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.
Name string
The resource name in the format projects/*/locations/*/connectors/*.
Network string
Name of a VPC network.
Project Changes to this property will trigger replacement. string
Subnet SubnetArgs
The subnet in which to house the VPC Access Connector.
connectorId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID to use for this connector.
ipCidrRange String
The range of internal addresses that follows RFC 4632 notation. Example: 10.132.0.0/28.
location Changes to this property will trigger replacement. String
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.
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.
minInstances Integer
Minimum value of instances in autoscaling group underlying the 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.
name String
The resource name in the format projects/*/locations/*/connectors/*.
network String
Name of a VPC network.
project Changes to this property will trigger replacement. String
subnet Subnet
The subnet in which to house the VPC Access Connector.
connectorId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for this connector.
ipCidrRange string
The range of internal addresses that follows RFC 4632 notation. Example: 10.132.0.0/28.
location Changes to this property will trigger replacement. string
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.
maxThroughput number
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.
minInstances number
Minimum value of instances in autoscaling group underlying the connector.
minThroughput number
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.
name string
The resource name in the format projects/*/locations/*/connectors/*.
network string
Name of a VPC network.
project Changes to this property will trigger replacement. string
subnet Subnet
The subnet in which to house the VPC Access Connector.
connector_id
This property is required.
Changes to this property will trigger replacement.
str
Required. The ID to use for this connector.
ip_cidr_range str
The range of internal addresses that follows RFC 4632 notation. Example: 10.132.0.0/28.
location Changes to this property will trigger replacement. str
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.
max_throughput int
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.
min_instances int
Minimum value of instances in autoscaling group underlying the connector.
min_throughput int
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.
name str
The resource name in the format projects/*/locations/*/connectors/*.
network str
Name of a VPC network.
project Changes to this property will trigger replacement. str
subnet SubnetArgs
The subnet in which to house the VPC Access Connector.
connectorId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID to use for this connector.
ipCidrRange String
The range of internal addresses that follows RFC 4632 notation. Example: 10.132.0.0/28.
location Changes to this property will trigger replacement. String
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.
maxThroughput Number
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.
minInstances Number
Minimum value of instances in autoscaling group underlying the connector.
minThroughput Number
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.
name String
The resource name in the format projects/*/locations/*/connectors/*.
network String
Name of a VPC network.
project Changes to this property will trigger replacement. String
subnet Property Map
The subnet in which to house the VPC Access Connector.

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.
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.
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.
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.
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.
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.
state String
State of the VPC access connector.

Supporting Types

Subnet
, SubnetArgs

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}
Project 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}
Project 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}
project 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}
project 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 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}
project 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.

SubnetResponse
, SubnetResponseArgs

Name This property is required. 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}
Project This property is required. 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 This property is required. 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}
Project This property is required. 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 This property is required. 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}
project This property is required. 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 This property is required. 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}
project This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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}
project This property is required. 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.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native