Google Cloud Native v0.30.0, Apr 14 23

google-native.vpcaccess/v1.getConnector

Explore with Pulumi AI

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>

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]

func LookupConnector(ctx *Context, args *LookupConnectorArgs, opts ...InvokeOption) (*LookupConnectorResult, error)
func LookupConnectorOutput(ctx *Context, args *LookupConnectorOutputArgs, opts ...InvokeOption) LookupConnectorResultOutput

> 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)
}

public static CompletableFuture<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:vpcaccess/v1:getConnector
  arguments:
    # arguments dictionary

The following arguments are supported:

ConnectorId string
Location string
Project string

ConnectorId string
Location string
Project string

connectorId String
location String
project String

connectorId string
location string
project string

connector_id str
location str
project str

connectorId String
location 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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 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.

Package Details

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