Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Twingate
  3. API Docs
  4. getTwingateConnector
Twingate v3.0.16 published on Thursday, Feb 20, 2025 by Twingate
twingate/pulumi-twingate

twingate.getTwingateConnector

Explore with Pulumi AI

twingate logo
Twingate v3.0.16 published on Thursday, Feb 20, 2025 by Twingate
twingate/pulumi-twingate

    Connectors provide connectivity to Remote Networks. For more information, see Twingate’s documentation.

    Example Usage

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

const foo = twingate.getTwingateConnector({
    id: "<your connector's id>",
});

    import pulumi
import pulumi_twingate as twingate

foo = twingate.get_twingate_connector(id="<your connector's id>")

    package main

import (
	"github.com/Twingate/pulumi-twingate/sdk/v3/go/twingate"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := twingate.LookupTwingateConnector(ctx, &twingate.LookupTwingateConnectorArgs{
			Id: "<your connector's id>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Twingate = Pulumi.Twingate;

return await Deployment.RunAsync(() => 
{
    var foo = Twingate.GetTwingateConnector.Invoke(new()
    {
        Id = "<your connector's id>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.twingate.TwingateFunctions;
import com.pulumi.twingate.inputs.GetTwingateConnectorArgs;
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) {
        final var foo = TwingateFunctions.getTwingateConnector(GetTwingateConnectorArgs.builder()
            .id("<your connector's id>")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      function: twingate:getTwingateConnector
      arguments:
        id: <your connector's id>

    Using getTwingateConnector

    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 getTwingateConnector(args: GetTwingateConnectorArgs, opts?: InvokeOptions): Promise<GetTwingateConnectorResult>
function getTwingateConnectorOutput(args: GetTwingateConnectorOutputArgs, opts?: InvokeOptions): Output<GetTwingateConnectorResult>
    def get_twingate_connector(id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetTwingateConnectorResult
def get_twingate_connector_output(id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetTwingateConnectorResult]
    func LookupTwingateConnector(ctx *Context, args *LookupTwingateConnectorArgs, opts ...InvokeOption) (*LookupTwingateConnectorResult, error)
func LookupTwingateConnectorOutput(ctx *Context, args *LookupTwingateConnectorOutputArgs, opts ...InvokeOption) LookupTwingateConnectorResultOutput

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

    public static class GetTwingateConnector 
{
    public static Task<GetTwingateConnectorResult> InvokeAsync(GetTwingateConnectorArgs args, InvokeOptions? opts = null)
    public static Output<GetTwingateConnectorResult> Invoke(GetTwingateConnectorInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTwingateConnectorResult> getTwingateConnector(GetTwingateConnectorArgs args, InvokeOptions options)
public static Output<GetTwingateConnectorResult> getTwingateConnector(GetTwingateConnectorArgs args, InvokeOptions options)

    fn::invoke:
  function: twingate:index/getTwingateConnector:getTwingateConnector
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of the Connector. The ID for the Connector can be obtained from the Admin API or the URL string in the Admin Console.
    Id string
    The ID of the Connector. The ID for the Connector can be obtained from the Admin API or the URL string in the Admin Console.
    id String
    The ID of the Connector. The ID for the Connector can be obtained from the Admin API or the URL string in the Admin Console.
    id string
    The ID of the Connector. The ID for the Connector can be obtained from the Admin API or the URL string in the Admin Console.
    id str
    The ID of the Connector. The ID for the Connector can be obtained from the Admin API or the URL string in the Admin Console.
    id String
    The ID of the Connector. The ID for the Connector can be obtained from the Admin API or the URL string in the Admin Console.

    getTwingateConnector Result

    The following output properties are available:

    Hostname string
    The hostname of the machine hosting the Connector.
    Id string
    The ID of the Connector. The ID for the Connector can be obtained from the Admin API or the URL string in the Admin Console.
    Name string
    The name of the Connector.
    PrivateIps List<string>
    The Connector's private IP addresses.
    PublicIp string
    The Connector's public IP address.
    RemoteNetworkId string
    The ID of the Remote Network the Connector is attached to.
    State string
    The Connector's state. One of ALIVE, DEAD_NO_HEARTBEAT, DEAD_HEARTBEAT_TOO_OLD or DEAD_NO_RELAYS.
    StatusUpdatesEnabled bool
    Determines whether status notifications are enabled for the Connector.
    Version string
    The Connector's version.
    Hostname string
    The hostname of the machine hosting the Connector.
    Id string
    The ID of the Connector. The ID for the Connector can be obtained from the Admin API or the URL string in the Admin Console.
    Name string
    The name of the Connector.
    PrivateIps []string
    The Connector's private IP addresses.
    PublicIp string
    The Connector's public IP address.
    RemoteNetworkId string
    The ID of the Remote Network the Connector is attached to.
    State string
    The Connector's state. One of ALIVE, DEAD_NO_HEARTBEAT, DEAD_HEARTBEAT_TOO_OLD or DEAD_NO_RELAYS.
    StatusUpdatesEnabled bool
    Determines whether status notifications are enabled for the Connector.
    Version string
    The Connector's version.
    hostname String
    The hostname of the machine hosting the Connector.
    id String
    The ID of the Connector. The ID for the Connector can be obtained from the Admin API or the URL string in the Admin Console.
    name String
    The name of the Connector.
    privateIps List<String>
    The Connector's private IP addresses.
    publicIp String
    The Connector's public IP address.
    remoteNetworkId String
    The ID of the Remote Network the Connector is attached to.
    state String
    The Connector's state. One of ALIVE, DEAD_NO_HEARTBEAT, DEAD_HEARTBEAT_TOO_OLD or DEAD_NO_RELAYS.
    statusUpdatesEnabled Boolean
    Determines whether status notifications are enabled for the Connector.
    version String
    The Connector's version.
    hostname string
    The hostname of the machine hosting the Connector.
    id string
    The ID of the Connector. The ID for the Connector can be obtained from the Admin API or the URL string in the Admin Console.
    name string
    The name of the Connector.
    privateIps string[]
    The Connector's private IP addresses.
    publicIp string
    The Connector's public IP address.
    remoteNetworkId string
    The ID of the Remote Network the Connector is attached to.
    state string
    The Connector's state. One of ALIVE, DEAD_NO_HEARTBEAT, DEAD_HEARTBEAT_TOO_OLD or DEAD_NO_RELAYS.
    statusUpdatesEnabled boolean
    Determines whether status notifications are enabled for the Connector.
    version string
    The Connector's version.
    hostname str
    The hostname of the machine hosting the Connector.
    id str
    The ID of the Connector. The ID for the Connector can be obtained from the Admin API or the URL string in the Admin Console.
    name str
    The name of the Connector.
    private_ips Sequence[str]
    The Connector's private IP addresses.
    public_ip str
    The Connector's public IP address.
    remote_network_id str
    The ID of the Remote Network the Connector is attached to.
    state str
    The Connector's state. One of ALIVE, DEAD_NO_HEARTBEAT, DEAD_HEARTBEAT_TOO_OLD or DEAD_NO_RELAYS.
    status_updates_enabled bool
    Determines whether status notifications are enabled for the Connector.
    version str
    The Connector's version.
    hostname String
    The hostname of the machine hosting the Connector.
    id String
    The ID of the Connector. The ID for the Connector can be obtained from the Admin API or the URL string in the Admin Console.
    name String
    The name of the Connector.
    privateIps List<String>
    The Connector's private IP addresses.
    publicIp String
    The Connector's public IP address.
    remoteNetworkId String
    The ID of the Remote Network the Connector is attached to.
    state String
    The Connector's state. One of ALIVE, DEAD_NO_HEARTBEAT, DEAD_HEARTBEAT_TOO_OLD or DEAD_NO_RELAYS.
    statusUpdatesEnabled Boolean
    Determines whether status notifications are enabled for the Connector.
    version String
    The Connector's version.

    Package Details

    Repository
    twingate Twingate/pulumi-twingate
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the twingate Terraform Provider.
    twingate logo
    Twingate v3.0.16 published on Thursday, Feb 20, 2025 by Twingate
    twingate/pulumi-twingate