@natzka-oss/pulumi-netbox/vpn/vpnTunnelTermination.d.ts

A Pulumi package for creating and managing Netbox cloud resources.

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",
 *     description: "description",
 * });
 * const testVpnTunnel = new netbox.vpn.VpnTunnel("test", {
 *     name: "my-tunnel",
 *     encapsulation: "ipsec-transport",
 *     status: "active",
 *     tunnelGroupId: test.id,
 * });
 * const device = new netbox.vpn.VpnTunnelTermination("device", {
 *     role: "peer",
 *     tunnelId: testVpnTunnel.id,
 *     deviceInterfaceId: 123,
 * });
 * const vm = new netbox.vpn.VpnTunnelTermination("vm", {
 *     role: "peer",
 *     tunnelId: testVpnTunnel.id,
 *     virtualMachineInterfaceId: 234,
 * });
 * ```
 */
export declare class VpnTunnelTermination extends pulumi.CustomResource {
    /**
     * Get an existing VpnTunnelTermination 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?: VpnTunnelTerminationState, opts?: pulumi.CustomResourceOptions): VpnTunnelTermination;
    /**
     * Returns true if the given object is an instance of VpnTunnelTermination.  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 VpnTunnelTermination;
    /**
     * Exactly one of `virtualMachineInterfaceId` or `deviceInterfaceId` must be given.
     */
    readonly deviceInterfaceId: pulumi.Output<number | undefined>;
    readonly outsideIpAddressId: pulumi.Output<number | undefined>;
    /**
     * Valid values are `peer`, `hub` and `spoke`.
     */
    readonly role: pulumi.Output<string>;
    readonly tags: pulumi.Output<string[] | undefined>;
    readonly tunnelId: pulumi.Output<number>;
    /**
     * Exactly one of `virtualMachineInterfaceId` or `deviceInterfaceId` must be given.
     */
    readonly virtualMachineInterfaceId: pulumi.Output<number | undefined>;
    /**
     * Create a VpnTunnelTermination 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: VpnTunnelTerminationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering VpnTunnelTermination resources.
 */
export interface VpnTunnelTerminationState {
    /**
     * Exactly one of `virtualMachineInterfaceId` or `deviceInterfaceId` must be given.
     */
    deviceInterfaceId?: pulumi.Input<number>;
    outsideIpAddressId?: pulumi.Input<number>;
    /**
     * Valid values are `peer`, `hub` and `spoke`.
     */
    role?: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    tunnelId?: pulumi.Input<number>;
    /**
     * Exactly one of `virtualMachineInterfaceId` or `deviceInterfaceId` must be given.
     */
    virtualMachineInterfaceId?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a VpnTunnelTermination resource.
 */
export interface VpnTunnelTerminationArgs {
    /**
     * Exactly one of `virtualMachineInterfaceId` or `deviceInterfaceId` must be given.
     */
    deviceInterfaceId?: pulumi.Input<number>;
    outsideIpAddressId?: pulumi.Input<number>;
    /**
     * Valid values are `peer`, `hub` and `spoke`.
     */
    role: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    tunnelId: pulumi.Input<number>;
    /**
     * Exactly one of `virtualMachineInterfaceId` or `deviceInterfaceId` must be given.
     */
    virtualMachineInterfaceId?: pulumi.Input<number>;
}