@twingate-labs/pulumi-twingate/twingateResource.d.ts

A Pulumi package for creating and managing Twingate cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
export declare class TwingateResource extends pulumi.CustomResource {
    /**
     * Get an existing TwingateResource 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?: TwingateResourceState, opts?: pulumi.CustomResourceOptions): TwingateResource;
    /**
     * Returns true if the given object is an instance of TwingateResource.  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 TwingateResource;
    /**
     * Restrict access to certain groups or service accounts
     */
    readonly access: pulumi.Output<outputs.TwingateResourceAccess | undefined>;
    /**
     * The Resource's IP/CIDR or FQDN/DNS zone
     */
    readonly address: pulumi.Output<string>;
    /**
     * Set a DNS alias address for the Resource. Must be a DNS-valid name string.
     */
    readonly alias: pulumi.Output<string | undefined>;
    /**
     * Determines whether assignments in the access block will override any existing assignments. Default is `true`. If set to
     * `false`, assignments made outside of Terraform will be ignored.
     */
    readonly isAuthoritative: pulumi.Output<boolean>;
    /**
     * Controls whether an "Open in Browser" shortcut will be shown for this Resource in the Twingate Client.
     */
    readonly isBrowserShortcutEnabled: pulumi.Output<boolean>;
    /**
     * Controls whether this Resource will be visible in the main Resource list in the Twingate Client.
     */
    readonly isVisible: pulumi.Output<boolean>;
    /**
     * The name of the Resource
     */
    readonly name: pulumi.Output<string>;
    /**
     * Restrict access to certain protocols and ports. By default or when this argument is not defined, there is no
     * restriction, and all protocols and ports are allowed.
     */
    readonly protocols: pulumi.Output<outputs.TwingateResourceProtocols | undefined>;
    /**
     * Remote Network ID where the Resource lives
     */
    readonly remoteNetworkId: pulumi.Output<string>;
    /**
     * Create a TwingateResource 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: TwingateResourceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering TwingateResource resources.
 */
export interface TwingateResourceState {
    /**
     * Restrict access to certain groups or service accounts
     */
    access?: pulumi.Input<inputs.TwingateResourceAccess>;
    /**
     * The Resource's IP/CIDR or FQDN/DNS zone
     */
    address?: pulumi.Input<string>;
    /**
     * Set a DNS alias address for the Resource. Must be a DNS-valid name string.
     */
    alias?: pulumi.Input<string>;
    /**
     * Determines whether assignments in the access block will override any existing assignments. Default is `true`. If set to
     * `false`, assignments made outside of Terraform will be ignored.
     */
    isAuthoritative?: pulumi.Input<boolean>;
    /**
     * Controls whether an "Open in Browser" shortcut will be shown for this Resource in the Twingate Client.
     */
    isBrowserShortcutEnabled?: pulumi.Input<boolean>;
    /**
     * Controls whether this Resource will be visible in the main Resource list in the Twingate Client.
     */
    isVisible?: pulumi.Input<boolean>;
    /**
     * The name of the Resource
     */
    name?: pulumi.Input<string>;
    /**
     * Restrict access to certain protocols and ports. By default or when this argument is not defined, there is no
     * restriction, and all protocols and ports are allowed.
     */
    protocols?: pulumi.Input<inputs.TwingateResourceProtocols>;
    /**
     * Remote Network ID where the Resource lives
     */
    remoteNetworkId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a TwingateResource resource.
 */
export interface TwingateResourceArgs {
    /**
     * Restrict access to certain groups or service accounts
     */
    access?: pulumi.Input<inputs.TwingateResourceAccess>;
    /**
     * The Resource's IP/CIDR or FQDN/DNS zone
     */
    address: pulumi.Input<string>;
    /**
     * Set a DNS alias address for the Resource. Must be a DNS-valid name string.
     */
    alias?: pulumi.Input<string>;
    /**
     * Determines whether assignments in the access block will override any existing assignments. Default is `true`. If set to
     * `false`, assignments made outside of Terraform will be ignored.
     */
    isAuthoritative?: pulumi.Input<boolean>;
    /**
     * Controls whether an "Open in Browser" shortcut will be shown for this Resource in the Twingate Client.
     */
    isBrowserShortcutEnabled?: pulumi.Input<boolean>;
    /**
     * Controls whether this Resource will be visible in the main Resource list in the Twingate Client.
     */
    isVisible?: pulumi.Input<boolean>;
    /**
     * The name of the Resource
     */
    name?: pulumi.Input<string>;
    /**
     * Restrict access to certain protocols and ports. By default or when this argument is not defined, there is no
     * restriction, and all protocols and ports are allowed.
     */
    protocols?: pulumi.Input<inputs.TwingateResourceProtocols>;
    /**
     * Remote Network ID where the Resource lives
     */
    remoteNetworkId: pulumi.Input<string>;
}