pulumi-dokploy/sdk/nodejs/port.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 utilities from "./utilities";

/**
 * A published port that exposes an application directly on the host, bypassing Traefik.
 */
export class Port extends pulumi.CustomResource {
    /**
     * Get an existing Port 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?: PortState, opts?: pulumi.CustomResourceOptions): Port {
        return new Port(name, <any>state, { ...opts, id: id });
    }

    /** @internal */
    public static readonly __pulumiType = 'dokploy:index/port:Port';

    /**
     * Returns true if the given object is an instance of Port.  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 Port {
        if (obj === undefined || obj === null) {
            return false;
        }
        return obj['__pulumiType'] === Port.__pulumiType;
    }

    /**
     * Application this port belongs to.
     */
    declare public readonly applicationId: pulumi.Output<string>;
    /**
     * Transport protocol. Valid values: `tcp`, `udp`.
     */
    declare public readonly protocol: pulumi.Output<string>;
    /**
     * Docker Swarm publish mode. `host` binds directly to the node; `ingress` uses the swarm routing mesh. Valid values: `ingress`, `host`.
     */
    declare public readonly publishMode: pulumi.Output<string>;
    /**
     * Port exposed on the host.
     */
    declare public readonly publishedPort: pulumi.Output<number>;
    /**
     * Port the container listens on.
     */
    declare public readonly targetPort: pulumi.Output<number>;

    /**
     * Create a Port 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: PortArgs, opts?: pulumi.CustomResourceOptions)
    constructor(name: string, argsOrState?: PortArgs | PortState, opts?: pulumi.CustomResourceOptions) {
        let resourceInputs: pulumi.Inputs = {};
        opts = opts || {};
        if (opts.id) {
            const state = argsOrState as PortState | undefined;
            resourceInputs["applicationId"] = state?.applicationId;
            resourceInputs["protocol"] = state?.protocol;
            resourceInputs["publishMode"] = state?.publishMode;
            resourceInputs["publishedPort"] = state?.publishedPort;
            resourceInputs["targetPort"] = state?.targetPort;
        } else {
            const args = argsOrState as PortArgs | undefined;
            if (args?.applicationId === undefined && !opts.urn) {
                throw new Error("Missing required property 'applicationId'");
            }
            if (args?.protocol === undefined && !opts.urn) {
                throw new Error("Missing required property 'protocol'");
            }
            if (args?.publishedPort === undefined && !opts.urn) {
                throw new Error("Missing required property 'publishedPort'");
            }
            if (args?.targetPort === undefined && !opts.urn) {
                throw new Error("Missing required property 'targetPort'");
            }
            resourceInputs["applicationId"] = args?.applicationId;
            resourceInputs["protocol"] = args?.protocol;
            resourceInputs["publishMode"] = args?.publishMode;
            resourceInputs["publishedPort"] = args?.publishedPort;
            resourceInputs["targetPort"] = args?.targetPort;
        }
        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
        super(Port.__pulumiType, name, resourceInputs, opts);
    }
}

/**
 * Input properties used for looking up and filtering Port resources.
 */
export interface PortState {
    /**
     * Application this port belongs to.
     */
    applicationId?: pulumi.Input<string | undefined>;
    /**
     * Transport protocol. Valid values: `tcp`, `udp`.
     */
    protocol?: pulumi.Input<string | undefined>;
    /**
     * Docker Swarm publish mode. `host` binds directly to the node; `ingress` uses the swarm routing mesh. Valid values: `ingress`, `host`.
     */
    publishMode?: pulumi.Input<string | undefined>;
    /**
     * Port exposed on the host.
     */
    publishedPort?: pulumi.Input<number | undefined>;
    /**
     * Port the container listens on.
     */
    targetPort?: pulumi.Input<number | undefined>;
}

/**
 * The set of arguments for constructing a Port resource.
 */
export interface PortArgs {
    /**
     * Application this port belongs to.
     */
    applicationId: pulumi.Input<string>;
    /**
     * Transport protocol. Valid values: `tcp`, `udp`.
     */
    protocol: pulumi.Input<string>;
    /**
     * Docker Swarm publish mode. `host` binds directly to the node; `ingress` uses the swarm routing mesh. Valid values: `ingress`, `host`.
     */
    publishMode?: pulumi.Input<string | undefined>;
    /**
     * Port exposed on the host.
     */
    publishedPort: pulumi.Input<number>;
    /**
     * Port the container listens on.
     */
    targetPort: pulumi.Input<number>;
}