Twingate v3.0.12, Nov 5 24

Twingate v3.0.12 published on Tuesday, Nov 5, 2024 by Twingate

twingate.getTwingateConnectors

Explore with Pulumi AI

Twingate v3.0.12 published on Tuesday, Nov 5, 2024 by Twingate

Example Usage

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

const all = twingate.getTwingateConnectors({
    name: "<your connector's name>",
});

import pulumi
import pulumi_twingate as twingate

all = twingate.get_twingate_connectors(name="<your connector's name>")

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.GetTwingateConnectors(ctx, &twingate.GetTwingateConnectorsArgs{
			Name: pulumi.StringRef("<your connector's name>"),
		}, 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 all = Twingate.GetTwingateConnectors.Invoke(new()
    {
        Name = "<your connector's name>",
    });

});

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.GetTwingateConnectorsArgs;
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 all = TwingateFunctions.getTwingateConnectors(GetTwingateConnectorsArgs.builder()
            .name("<your connector's name>")
            .build());

    }
}

variables:
  all:
    fn::invoke:
      Function: twingate:getTwingateConnectors
      Arguments:
        name: <your connector's name>

Using getTwingateConnectors

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 getTwingateConnectors(args: GetTwingateConnectorsArgs, opts?: InvokeOptions): Promise<GetTwingateConnectorsResult>
function getTwingateConnectorsOutput(args: GetTwingateConnectorsOutputArgs, opts?: InvokeOptions): Output<GetTwingateConnectorsResult>

def get_twingate_connectors(name: Optional[str] = None,
                            name_contains: Optional[str] = None,
                            name_exclude: Optional[str] = None,
                            name_prefix: Optional[str] = None,
                            name_regexp: Optional[str] = None,
                            name_suffix: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetTwingateConnectorsResult
def get_twingate_connectors_output(name: Optional[pulumi.Input[str]] = None,
                            name_contains: Optional[pulumi.Input[str]] = None,
                            name_exclude: Optional[pulumi.Input[str]] = None,
                            name_prefix: Optional[pulumi.Input[str]] = None,
                            name_regexp: Optional[pulumi.Input[str]] = None,
                            name_suffix: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetTwingateConnectorsResult]

func GetTwingateConnectors(ctx *Context, args *GetTwingateConnectorsArgs, opts ...InvokeOption) (*GetTwingateConnectorsResult, error)
func GetTwingateConnectorsOutput(ctx *Context, args *GetTwingateConnectorsOutputArgs, opts ...InvokeOption) GetTwingateConnectorsResultOutput

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

public static class GetTwingateConnectors 
{
    public static Task<GetTwingateConnectorsResult> InvokeAsync(GetTwingateConnectorsArgs args, InvokeOptions? opts = null)
    public static Output<GetTwingateConnectorsResult> Invoke(GetTwingateConnectorsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTwingateConnectorsResult> getTwingateConnectors(GetTwingateConnectorsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

Name string: Returns only connectors that exactly match this name. If no options are passed it will return all connectors. Only one option can be used at a time.
NameContains string: Match when the value exist in the name of the connector.
NameExclude string: Match when the exact value does not exist in the name of the connector.
NamePrefix string: The name of the connector must start with the value.
NameRegexp string: The regular expression match of the name of the connector.
NameSuffix string: The name of the connector must end with the value.

Name string: Returns only connectors that exactly match this name. If no options are passed it will return all connectors. Only one option can be used at a time.
NameContains string: Match when the value exist in the name of the connector.
NameExclude string: Match when the exact value does not exist in the name of the connector.
NamePrefix string: The name of the connector must start with the value.
NameRegexp string: The regular expression match of the name of the connector.
NameSuffix string: The name of the connector must end with the value.

name String: Returns only connectors that exactly match this name. If no options are passed it will return all connectors. Only one option can be used at a time.
nameContains String: Match when the value exist in the name of the connector.
nameExclude String: Match when the exact value does not exist in the name of the connector.
namePrefix String: The name of the connector must start with the value.
nameRegexp String: The regular expression match of the name of the connector.
nameSuffix String: The name of the connector must end with the value.

name string: Returns only connectors that exactly match this name. If no options are passed it will return all connectors. Only one option can be used at a time.
nameContains string: Match when the value exist in the name of the connector.
nameExclude string: Match when the exact value does not exist in the name of the connector.
namePrefix string: The name of the connector must start with the value.
nameRegexp string: The regular expression match of the name of the connector.
nameSuffix string: The name of the connector must end with the value.

name str: Returns only connectors that exactly match this name. If no options are passed it will return all connectors. Only one option can be used at a time.
name_contains str: Match when the value exist in the name of the connector.
name_exclude str: Match when the exact value does not exist in the name of the connector.
name_prefix str: The name of the connector must start with the value.
name_regexp str: The regular expression match of the name of the connector.
name_suffix str: The name of the connector must end with the value.

name String: Returns only connectors that exactly match this name. If no options are passed it will return all connectors. Only one option can be used at a time.
nameContains String: Match when the value exist in the name of the connector.
nameExclude String: Match when the exact value does not exist in the name of the connector.
namePrefix String: The name of the connector must start with the value.
nameRegexp String: The regular expression match of the name of the connector.
nameSuffix String: The name of the connector must end with the value.

getTwingateConnectors Result

The following output properties are available:

Connectors List<Twingate.Twingate.Outputs.GetTwingateConnectorsConnector>: List of Connectors
Id string: The ID of this resource.
Name string: Returns only connectors that exactly match this name. If no options are passed it will return all connectors. Only one option can be used at a time.
NameContains string: Match when the value exist in the name of the connector.
NameExclude string: Match when the exact value does not exist in the name of the connector.
NamePrefix string: The name of the connector must start with the value.
NameRegexp string: The regular expression match of the name of the connector.
NameSuffix string: The name of the connector must end with the value.

Connectors []GetTwingateConnectorsConnector: List of Connectors
Id string: The ID of this resource.
Name string: Returns only connectors that exactly match this name. If no options are passed it will return all connectors. Only one option can be used at a time.
NameContains string: Match when the value exist in the name of the connector.
NameExclude string: Match when the exact value does not exist in the name of the connector.
NamePrefix string: The name of the connector must start with the value.
NameRegexp string: The regular expression match of the name of the connector.
NameSuffix string: The name of the connector must end with the value.

connectors List<GetTwingateConnectorsConnector>: List of Connectors
id String: The ID of this resource.
name String: Returns only connectors that exactly match this name. If no options are passed it will return all connectors. Only one option can be used at a time.
nameContains String: Match when the value exist in the name of the connector.
nameExclude String: Match when the exact value does not exist in the name of the connector.
namePrefix String: The name of the connector must start with the value.
nameRegexp String: The regular expression match of the name of the connector.
nameSuffix String: The name of the connector must end with the value.

connectors GetTwingateConnectorsConnector[]: List of Connectors
id string: The ID of this resource.
name string: Returns only connectors that exactly match this name. If no options are passed it will return all connectors. Only one option can be used at a time.
nameContains string: Match when the value exist in the name of the connector.
nameExclude string: Match when the exact value does not exist in the name of the connector.
namePrefix string: The name of the connector must start with the value.
nameRegexp string: The regular expression match of the name of the connector.
nameSuffix string: The name of the connector must end with the value.

connectors Sequence[GetTwingateConnectorsConnector]: List of Connectors
id str: The ID of this resource.
name str: Returns only connectors that exactly match this name. If no options are passed it will return all connectors. Only one option can be used at a time.
name_contains str: Match when the value exist in the name of the connector.
name_exclude str: Match when the exact value does not exist in the name of the connector.
name_prefix str: The name of the connector must start with the value.
name_regexp str: The regular expression match of the name of the connector.
name_suffix str: The name of the connector must end with the value.

connectors List<Property Map>: List of Connectors
id String: The ID of this resource.
name String: Returns only connectors that exactly match this name. If no options are passed it will return all connectors. Only one option can be used at a time.
nameContains String: Match when the value exist in the name of the connector.
nameExclude String: Match when the exact value does not exist in the name of the connector.
namePrefix String: The name of the connector must start with the value.
nameRegexp String: The regular expression match of the name of the connector.
nameSuffix String: The name of the connector must end with the value.

Supporting Types

GetTwingateConnectorsConnector

Id string: The ID of the Connector.
Name string: The Name of the Connector.
RemoteNetworkId string: The ID of the Remote Network attached to the Connector.
StatusUpdatesEnabled bool: Determines whether status notifications are enabled for the Connector.

Id string: The ID of the Connector.
Name string: The Name of the Connector.
RemoteNetworkId string: The ID of the Remote Network attached to the Connector.
StatusUpdatesEnabled bool: Determines whether status notifications are enabled for the Connector.

id String: The ID of the Connector.
name String: The Name of the Connector.
remoteNetworkId String: The ID of the Remote Network attached to the Connector.
statusUpdatesEnabled Boolean: Determines whether status notifications are enabled for the Connector.

id string: The ID of the Connector.
name string: The Name of the Connector.
remoteNetworkId string: The ID of the Remote Network attached to the Connector.
statusUpdatesEnabled boolean: Determines whether status notifications are enabled for the Connector.

id str: The ID of the Connector.
name str: The Name of the Connector.
remote_network_id str: The ID of the Remote Network attached to the Connector.
status_updates_enabled bool: Determines whether status notifications are enabled for the Connector.

id String: The ID of the Connector.
name String: The Name of the Connector.
remoteNetworkId String: The ID of the Remote Network attached to the Connector.
statusUpdatesEnabled Boolean: Determines whether status notifications are enabled for the Connector.

Package Details

Repository: twingate Twingate/pulumi-twingate
License: Apache-2.0
Notes: This Pulumi package is based on the twingate Terraform Provider.

Twingate v3.0.12 published on Tuesday, Nov 5, 2024 by Twingate

Twingate/pulumi-twingate

twingate.getTwingateConnectors

On this page

On this page

Example Usage

Using getTwingateConnectors

getTwingateConnectors Result

Supporting Types

GetTwingateConnectorsConnector

Package Details

On this page

On this page