@emailbob/twingate/twingateConnector.d.ts

A Pulumi package for creating and managing Twingate cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Connectors provide connectivity to Remote Networks. This resource type will create the Connector in the Twingate Admin Console, but in order to successfully deploy it, you must also generate Connector tokens that authenticate the Connector with Twingate. 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 "@emailbob/twingate";
 *
 * const awsNetwork = new twingate.TwingateRemoteNetwork("awsNetwork", {});
 * const awsConnector = new twingate.TwingateConnector("awsConnector", {
 *     remoteNetworkId: awsNetwork.id,
 *     statusUpdatesEnabled: true,
 * });
 * ```
 * <!--End PulumiCodeChooser -->
 *
 * ## Import
 *
 * ```sh
 * $ pulumi import twingate:index/twingateConnector:TwingateConnector aws_connector Q29ubmVjdG9yOjI2NzM=
 * ```
 */
export declare class TwingateConnector extends pulumi.CustomResource {
    /**
     * Get an existing TwingateConnector resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TwingateConnectorState, opts?: pulumi.CustomResourceOptions): TwingateConnector;
    /**
     * Returns true if the given object is an instance of TwingateConnector.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is TwingateConnector;
    /**
     * Name of the Connector, if not provided one will be generated.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the Remote Network the Connector is attached to.
     */
    readonly remoteNetworkId: pulumi.Output<string>;
    /**
     * Determines whether status notifications are enabled for the Connector. Default is `true`.
     */
    readonly statusUpdatesEnabled: pulumi.Output<boolean>;
    /**
     * Create a TwingateConnector resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: TwingateConnectorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering TwingateConnector resources.
 */
export interface TwingateConnectorState {
    /**
     * Name of the Connector, if not provided one will be generated.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the Remote Network the Connector is attached to.
     */
    remoteNetworkId?: pulumi.Input<string>;
    /**
     * Determines whether status notifications are enabled for the Connector. Default is `true`.
     */
    statusUpdatesEnabled?: pulumi.Input<boolean>;
}
/**
 * The set of arguments for constructing a TwingateConnector resource.
 */
export interface TwingateConnectorArgs {
    /**
     * Name of the Connector, if not provided one will be generated.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the Remote Network the Connector is attached to.
     */
    remoteNetworkId: pulumi.Input<string>;
    /**
     * Determines whether status notifications are enabled for the Connector. Default is `true`.
     */
    statusUpdatesEnabled?: pulumi.Input<boolean>;
}