@emailbob/twingate
Version:
A Pulumi package for creating and managing Twingate cloud resources.
81 lines (80 loc) • 3.29 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A Remote Network represents a single private network in Twingate that can have one or more Connectors and Resources assigned to it. You must create a Remote Network before creating Resources and Connectors that belong to it. For more information, see Twingate's [documentation](https://docs.twingate.com/docs/remote-networks).
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as twingate from "@emailbob/twingate";
*
* const awsNetwork = new twingate.TwingateRemoteNetwork("awsNetwork", {});
* ```
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* ```sh
* $ pulumi import twingate:index/twingateRemoteNetwork:TwingateRemoteNetwork network UmVtb3RlTmV0d29zaipgMKIkNg==
* ```
*/
export declare class TwingateRemoteNetwork extends pulumi.CustomResource {
/**
* Get an existing TwingateRemoteNetwork 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?: TwingateRemoteNetworkState, opts?: pulumi.CustomResourceOptions): TwingateRemoteNetwork;
/**
* Returns true if the given object is an instance of TwingateRemoteNetwork. 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 TwingateRemoteNetwork;
/**
* The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLE*CLOUD, ON*PREMISE, OTHER.
*/
readonly location: pulumi.Output<string>;
/**
* The name of the Remote Network
*/
readonly name: pulumi.Output<string>;
/**
* Create a TwingateRemoteNetwork 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?: TwingateRemoteNetworkArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TwingateRemoteNetwork resources.
*/
export interface TwingateRemoteNetworkState {
/**
* The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLE*CLOUD, ON*PREMISE, OTHER.
*/
location?: pulumi.Input<string>;
/**
* The name of the Remote Network
*/
name?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a TwingateRemoteNetwork resource.
*/
export interface TwingateRemoteNetworkArgs {
/**
* The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLE*CLOUD, ON*PREMISE, OTHER.
*/
location?: pulumi.Input<string>;
/**
* The name of the Remote Network
*/
name?: pulumi.Input<string>;
}