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

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.getConnector

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

Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

Using getConnector

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConnector(args: GetConnectorArgs, opts?: InvokeOptions): Promise<GetConnectorResult>
function getConnectorOutput(args: GetConnectorOutputArgs, opts?: InvokeOptions): Output<GetConnectorResult>
Copy
def get_connector(connector_id: Optional[str] = None,
                  location: Optional[str] = None,
                  project: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetConnectorResult
def get_connector_output(connector_id: Optional[pulumi.Input[str]] = None,
                  location: Optional[pulumi.Input[str]] = None,
                  project: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetConnectorResult]
Copy
func LookupConnector(ctx *Context, args *LookupConnectorArgs, opts ...InvokeOption) (*LookupConnectorResult, error)
func LookupConnectorOutput(ctx *Context, args *LookupConnectorOutputArgs, opts ...InvokeOption) LookupConnectorResultOutput
Copy

> Note: This function is named LookupConnector in the Go SDK.

public static class GetConnector 
{
    public static Task<GetConnectorResult> InvokeAsync(GetConnectorArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectorResult> Invoke(GetConnectorInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Copy
fn::invoke:
  function: google-native:vpcaccess/v1:getConnector
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConnectorId This property is required. string
Location This property is required. string
Project string
ConnectorId This property is required. string
Location This property is required. string
Project string
connectorId This property is required. String
location This property is required. String
project String
connectorId This property is required. string
location This property is required. string
project string
connector_id This property is required. str
location This property is required. str
project str
connectorId This property is required. String
location This property is required. String
project String

getConnector Result

The following output properties are available:

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.
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.
State string
State of the VPC access connector.
Subnet Pulumi.GoogleNative.VPCAccess.V1.Outputs.SubnetResponse
The subnet in which to house the VPC Access Connector.
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.
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.
State string
State of the VPC access connector.
Subnet SubnetResponse
The subnet in which to house the VPC Access Connector.
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.
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.
state String
State of the VPC access connector.
subnet SubnetResponse
The subnet in which to house the VPC Access Connector.
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.
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.
state string
State of the VPC access connector.
subnet SubnetResponse
The subnet in which to house the VPC Access Connector.
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.
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.
state str
State of the VPC access connector.
subnet SubnetResponse
The subnet in which to house the VPC Access Connector.
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.
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.
state String
State of the VPC access connector.
subnet Property Map
The subnet in which to house the VPC Access Connector.

Supporting Types

SubnetResponse

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