pulumi-incus/sdk/nodejs/getNetworkForward.ts

// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
import * as utilities from "./utilities";

/**
 * ## # incus.NetworkForward
 *
 * Provides information about an Incus network forward.
 * See Incus network forward [configuration reference](https://linuxcontainers.org/incus/docs/main/howto/network_forwards/) for more details.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as incus from "@kiterun/incus";
 *
 * const _this = incus.getNetworkForward({
 *     listenAddress: "127.0.0.1",
 *     network: "parent",
 * });
 * export const networkForwardListenAddress = _this.then(_this => _this.listenAddress);
 * ```
 */
export function getNetworkForward(args: GetNetworkForwardArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkForwardResult> {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("incus:index/getNetworkForward:getNetworkForward", {
        "description": args.description,
        "listenAddress": args.listenAddress,
        "location": args.location,
        "network": args.network,
        "ports": args.ports,
        "project": args.project,
        "remote": args.remote,
        "target": args.target,
    }, opts);
}

/**
 * A collection of arguments for invoking getNetworkForward.
 */
export interface GetNetworkForwardArgs {
    /**
     * Description of the forward port.
     */
    description?: string;
    /**
     * **Required** - Listen Address of the network forward.
     */
    listenAddress: string;
    /**
     * Location of the network forward.
     */
    location?: string;
    /**
     * **Required** - Name of the parent network.
     */
    network: string;
    /**
     * List of ports to forward.
     */
    ports?: inputs.GetNetworkForwardPort[];
    /**
     * *Optional* - Name of the project where the network forward is be stored.
     */
    project?: string;
    /**
     * *Optional* - The remote in which the resource was created. If
     * not provided, the provider's default remote will be used.
     */
    remote?: string;
    /**
     * *Optional* - Specify a target node in a cluster.
     */
    target?: string;
}

/**
 * A collection of values returned by getNetworkForward.
 */
export interface GetNetworkForwardResult {
    /**
     * Map of key/value pairs of config settings.
     */
    readonly config: {[key: string]: string};
    /**
     * Description of the forward port.
     */
    readonly description: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly listenAddress: string;
    /**
     * Location of the network forward.
     */
    readonly location: string;
    readonly network: string;
    /**
     * List of ports to forward.
     */
    readonly ports: outputs.GetNetworkForwardPort[];
    readonly project?: string;
    readonly remote?: string;
    readonly target?: string;
}
/**
 * ## # incus.NetworkForward
 *
 * Provides information about an Incus network forward.
 * See Incus network forward [configuration reference](https://linuxcontainers.org/incus/docs/main/howto/network_forwards/) for more details.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as incus from "@kiterun/incus";
 *
 * const _this = incus.getNetworkForward({
 *     listenAddress: "127.0.0.1",
 *     network: "parent",
 * });
 * export const networkForwardListenAddress = _this.then(_this => _this.listenAddress);
 * ```
 */
export function getNetworkForwardOutput(args: GetNetworkForwardOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetNetworkForwardResult> {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("incus:index/getNetworkForward:getNetworkForward", {
        "description": args.description,
        "listenAddress": args.listenAddress,
        "location": args.location,
        "network": args.network,
        "ports": args.ports,
        "project": args.project,
        "remote": args.remote,
        "target": args.target,
    }, opts);
}

/**
 * A collection of arguments for invoking getNetworkForward.
 */
export interface GetNetworkForwardOutputArgs {
    /**
     * Description of the forward port.
     */
    description?: pulumi.Input<string>;
    /**
     * **Required** - Listen Address of the network forward.
     */
    listenAddress: pulumi.Input<string>;
    /**
     * Location of the network forward.
     */
    location?: pulumi.Input<string>;
    /**
     * **Required** - Name of the parent network.
     */
    network: pulumi.Input<string>;
    /**
     * List of ports to forward.
     */
    ports?: pulumi.Input<pulumi.Input<inputs.GetNetworkForwardPortArgs>[]>;
    /**
     * *Optional* - Name of the project where the network forward is be stored.
     */
    project?: pulumi.Input<string>;
    /**
     * *Optional* - The remote in which the resource was created. If
     * not provided, the provider's default remote will be used.
     */
    remote?: pulumi.Input<string>;
    /**
     * *Optional* - Specify a target node in a cluster.
     */
    target?: pulumi.Input<string>;
}