@emailbob/twingate/getTwingateConnectors.d.ts

A Pulumi package for creating and managing Twingate cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * Connectors provide connectivity to Remote Networks. For more information, see Twingate's [documentation](https://docs.twingate.com/docs/understanding-access-nodes).
 *
 * ## Example Usage
 *
 * <!--Start PulumiCodeChooser -->
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as twingate from "@pulumi/twingate";
 *
 * const all = twingate.getTwingateConnectors({
 *     name: "<your connector's name>",
 * });
 * ```
 * <!--End PulumiCodeChooser -->
 */
export declare function getTwingateConnectors(args?: GetTwingateConnectorsArgs, opts?: pulumi.InvokeOptions): Promise<GetTwingateConnectorsResult>;
/**
 * A collection of arguments for invoking getTwingateConnectors.
 */
export interface GetTwingateConnectorsArgs {
    /**
     * The Name of the Connector.
     */
    name?: string;
    /**
     * Match when the value exist in the name of the connector.
     */
    nameContains?: string;
    /**
     * Match when the exact value does not exist in the name of the connector.
     */
    nameExclude?: string;
    /**
     * The name of the connector must start with the value.
     */
    namePrefix?: string;
    /**
     * The regular expression match of the name of the connector.
     */
    nameRegexp?: string;
    /**
     * The name of the connector must end with the value.
     */
    nameSuffix?: string;
}
/**
 * A collection of values returned by getTwingateConnectors.
 */
export interface GetTwingateConnectorsResult {
    /**
     * List of Connectors
     */
    readonly connectors: outputs.GetTwingateConnectorsConnector[];
    /**
     * The ID of this resource.
     */
    readonly id: 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.
     */
    readonly name?: string;
    /**
     * Match when the value exist in the name of the connector.
     */
    readonly nameContains?: string;
    /**
     * Match when the exact value does not exist in the name of the connector.
     */
    readonly nameExclude?: string;
    /**
     * The name of the connector must start with the value.
     */
    readonly namePrefix?: string;
    /**
     * The regular expression match of the name of the connector.
     */
    readonly nameRegexp?: string;
    /**
     * The name of the connector must end with the value.
     */
    readonly nameSuffix?: string;
}
/**
 * Connectors provide connectivity to Remote Networks. For more information, see Twingate's [documentation](https://docs.twingate.com/docs/understanding-access-nodes).
 *
 * ## Example Usage
 *
 * <!--Start PulumiCodeChooser -->
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as twingate from "@pulumi/twingate";
 *
 * const all = twingate.getTwingateConnectors({
 *     name: "<your connector's name>",
 * });
 * ```
 * <!--End PulumiCodeChooser -->
 */
export declare function getTwingateConnectorsOutput(args?: GetTwingateConnectorsOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetTwingateConnectorsResult>;
/**
 * A collection of arguments for invoking getTwingateConnectors.
 */
export interface GetTwingateConnectorsOutputArgs {
    /**
     * The Name of the Connector.
     */
    name?: pulumi.Input<string>;
    /**
     * Match when the value exist in the name of the connector.
     */
    nameContains?: pulumi.Input<string>;
    /**
     * Match when the exact value does not exist in the name of the connector.
     */
    nameExclude?: pulumi.Input<string>;
    /**
     * The name of the connector must start with the value.
     */
    namePrefix?: pulumi.Input<string>;
    /**
     * The regular expression match of the name of the connector.
     */
    nameRegexp?: pulumi.Input<string>;
    /**
     * The name of the connector must end with the value.
     */
    nameSuffix?: pulumi.Input<string>;
}