@emailbob/twingate
Version:
A Pulumi package for creating and managing Twingate cloud resources.
99 lines (98 loc) • 3.98 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* This resource type will generate tokens for a Connector, which are needed to successfully provision one on your network. The Connector itself has its own resource type and must be created before you can provision tokens.
*
* ## 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});
* const awsConnectorTokens = new twingate.TwingateConnectorTokens("awsConnectorTokens", {connectorId: awsConnector.id});
* ```
* <!--End PulumiCodeChooser -->
*/
export declare class TwingateConnectorTokens extends pulumi.CustomResource {
/**
* Get an existing TwingateConnectorTokens 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?: TwingateConnectorTokensState, opts?: pulumi.CustomResourceOptions): TwingateConnectorTokens;
/**
* Returns true if the given object is an instance of TwingateConnectorTokens. 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 TwingateConnectorTokens;
/**
* The Access Token of the parent Connector
*/
readonly accessToken: pulumi.Output<string>;
/**
* The ID of the parent Connector
*/
readonly connectorId: pulumi.Output<string>;
/**
* Arbitrary map of values that, when changed, will trigger recreation of resource. Use this to automatically rotate Connector tokens on a schedule.
*/
readonly keepers: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The Refresh Token of the parent Connector
*/
readonly refreshToken: pulumi.Output<string>;
/**
* Create a TwingateConnectorTokens 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: TwingateConnectorTokensArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TwingateConnectorTokens resources.
*/
export interface TwingateConnectorTokensState {
/**
* The Access Token of the parent Connector
*/
accessToken?: pulumi.Input<string>;
/**
* The ID of the parent Connector
*/
connectorId?: pulumi.Input<string>;
/**
* Arbitrary map of values that, when changed, will trigger recreation of resource. Use this to automatically rotate Connector tokens on a schedule.
*/
keepers?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The Refresh Token of the parent Connector
*/
refreshToken?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a TwingateConnectorTokens resource.
*/
export interface TwingateConnectorTokensArgs {
/**
* The ID of the parent Connector
*/
connectorId: pulumi.Input<string>;
/**
* Arbitrary map of values that, when changed, will trigger recreation of resource. Use this to automatically rotate Connector tokens on a schedule.
*/
keepers?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}