pulumi-incus/sdk/nodejs/networkForward.ts

// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** 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";

export class NetworkForward extends pulumi.CustomResource {
    /**
     * Get an existing NetworkForward 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.
     */
    public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkForwardState, opts?: pulumi.CustomResourceOptions): NetworkForward {
        return new NetworkForward(name, <any>state, { ...opts, id: id });
    }

    /** @internal */
    public static readonly __pulumiType = 'incus:index/networkForward:NetworkForward';

    /**
     * Returns true if the given object is an instance of NetworkForward.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    public static isInstance(obj: any): obj is NetworkForward {
        if (obj === undefined || obj === null) {
            return false;
        }
        return obj['__pulumiType'] === NetworkForward.__pulumiType;
    }

    /**
     * *Optional* - Map of key/value pairs of
     * network forward config settings.
     */
    public readonly config!: pulumi.Output<{[key: string]: string}>;
    /**
     * *Optional* - Description of port(s)
     */
    public readonly description!: pulumi.Output<string>;
    /**
     * **Required** - IP address to listen on.
     */
    public readonly listenAddress!: pulumi.Output<string>;
    /**
     * **Required** - Name of the network.
     */
    public readonly network!: pulumi.Output<string>;
    /**
     * *Optional* - List of port specifications. See reference below.
     *
     * The network forward port supports:
     */
    public readonly ports!: pulumi.Output<outputs.NetworkForwardPort[]>;
    /**
     * *Optional* - Name of the project where the network forward will be created.
     */
    public readonly project!: pulumi.Output<string | undefined>;
    /**
     * *Optional* - The remote in which the resource will be created. If
     * not provided, the provider's default remote will be used.
     */
    public readonly remote!: pulumi.Output<string | undefined>;

    /**
     * Create a NetworkForward 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: NetworkForwardArgs, opts?: pulumi.CustomResourceOptions)
    constructor(name: string, argsOrState?: NetworkForwardArgs | NetworkForwardState, opts?: pulumi.CustomResourceOptions) {
        let resourceInputs: pulumi.Inputs = {};
        opts = opts || {};
        if (opts.id) {
            const state = argsOrState as NetworkForwardState | undefined;
            resourceInputs["config"] = state ? state.config : undefined;
            resourceInputs["description"] = state ? state.description : undefined;
            resourceInputs["listenAddress"] = state ? state.listenAddress : undefined;
            resourceInputs["network"] = state ? state.network : undefined;
            resourceInputs["ports"] = state ? state.ports : undefined;
            resourceInputs["project"] = state ? state.project : undefined;
            resourceInputs["remote"] = state ? state.remote : undefined;
        } else {
            const args = argsOrState as NetworkForwardArgs | undefined;
            if ((!args || args.listenAddress === undefined) && !opts.urn) {
                throw new Error("Missing required property 'listenAddress'");
            }
            if ((!args || args.network === undefined) && !opts.urn) {
                throw new Error("Missing required property 'network'");
            }
            resourceInputs["config"] = args ? args.config : undefined;
            resourceInputs["description"] = args ? args.description : undefined;
            resourceInputs["listenAddress"] = args ? args.listenAddress : undefined;
            resourceInputs["network"] = args ? args.network : undefined;
            resourceInputs["ports"] = args ? args.ports : undefined;
            resourceInputs["project"] = args ? args.project : undefined;
            resourceInputs["remote"] = args ? args.remote : undefined;
        }
        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
        super(NetworkForward.__pulumiType, name, resourceInputs, opts);
    }
}

/**
 * Input properties used for looking up and filtering NetworkForward resources.
 */
export interface NetworkForwardState {
    /**
     * *Optional* - Map of key/value pairs of
     * network forward config settings.
     */
    config?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
    /**
     * *Optional* - Description of port(s)
     */
    description?: pulumi.Input<string>;
    /**
     * **Required** - IP address to listen on.
     */
    listenAddress?: pulumi.Input<string>;
    /**
     * **Required** - Name of the network.
     */
    network?: pulumi.Input<string>;
    /**
     * *Optional* - List of port specifications. See reference below.
     *
     * The network forward port supports:
     */
    ports?: pulumi.Input<pulumi.Input<inputs.NetworkForwardPort>[]>;
    /**
     * *Optional* - Name of the project where the network forward will be created.
     */
    project?: pulumi.Input<string>;
    /**
     * *Optional* - The remote in which the resource will be created. If
     * not provided, the provider's default remote will be used.
     */
    remote?: pulumi.Input<string>;
}

/**
 * The set of arguments for constructing a NetworkForward resource.
 */
export interface NetworkForwardArgs {
    /**
     * *Optional* - Map of key/value pairs of
     * network forward config settings.
     */
    config?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
    /**
     * *Optional* - Description of port(s)
     */
    description?: pulumi.Input<string>;
    /**
     * **Required** - IP address to listen on.
     */
    listenAddress: pulumi.Input<string>;
    /**
     * **Required** - Name of the network.
     */
    network: pulumi.Input<string>;
    /**
     * *Optional* - List of port specifications. See reference below.
     *
     * The network forward port supports:
     */
    ports?: pulumi.Input<pulumi.Input<inputs.NetworkForwardPort>[]>;
    /**
     * *Optional* - Name of the project where the network forward will be created.
     */
    project?: pulumi.Input<string>;
    /**
     * *Optional* - The remote in which the resource will be created. If
     * not provided, the provider's default remote will be used.
     */
    remote?: pulumi.Input<string>;
}