@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
102 lines (101 loc) • 4.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/features/vpn-tunnels/):
*
* > NetBox can model private tunnels formed among virtual termination points across your network. Typical tunnel implementations include GRE, IP-in-IP, and IPSec. A tunnel may be terminated to two or more device or virtual machine interfaces. For convenient organization, tunnels may be assigned to user-defined groups.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const test = new netbox.vpn.VpnTunnelGroup("test", {name: "my-tunnel-group"});
* const testVpnTunnel = new netbox.vpn.VpnTunnel("test", {
* name: "my-tunnel",
* encapsulation: "ipsec-transport",
* status: "active",
* tunnelGroupId: test.id,
* description: "This is a description.",
* tunnelId: 3,
* tenantId: 2,
* });
* ```
*/
export declare class VpnTunnel extends pulumi.CustomResource {
/**
* Get an existing VpnTunnel 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?: VpnTunnelState, opts?: pulumi.CustomResourceOptions): VpnTunnel;
/**
* Returns true if the given object is an instance of VpnTunnel. 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 VpnTunnel;
readonly description: pulumi.Output<string | undefined>;
/**
* Valid values are `ipsec-transport`, `ipsec-tunnel`, `ip-ip` and `gre`.
*/
readonly encapsulation: pulumi.Output<string>;
readonly name: pulumi.Output<string>;
/**
* Valid values are `planned`, `active` and `disabled`.
*/
readonly status: pulumi.Output<string>;
readonly tags: pulumi.Output<string[] | undefined>;
readonly tenantId: pulumi.Output<number | undefined>;
readonly tunnelGroupId: pulumi.Output<number>;
readonly tunnelId: pulumi.Output<number | undefined>;
/**
* Create a VpnTunnel 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: VpnTunnelArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VpnTunnel resources.
*/
export interface VpnTunnelState {
description?: pulumi.Input<string>;
/**
* Valid values are `ipsec-transport`, `ipsec-tunnel`, `ip-ip` and `gre`.
*/
encapsulation?: pulumi.Input<string>;
name?: pulumi.Input<string>;
/**
* Valid values are `planned`, `active` and `disabled`.
*/
status?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tenantId?: pulumi.Input<number>;
tunnelGroupId?: pulumi.Input<number>;
tunnelId?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a VpnTunnel resource.
*/
export interface VpnTunnelArgs {
description?: pulumi.Input<string>;
/**
* Valid values are `ipsec-transport`, `ipsec-tunnel`, `ip-ip` and `gre`.
*/
encapsulation: pulumi.Input<string>;
name?: pulumi.Input<string>;
/**
* Valid values are `planned`, `active` and `disabled`.
*/
status: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tenantId?: pulumi.Input<number>;
tunnelGroupId: pulumi.Input<number>;
tunnelId?: pulumi.Input<number>;
}