pulumi-dokploy/sdk/nodejs/redirect.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 Traefik redirect rule attached to an application.
 */
export class Redirect extends pulumi.CustomResource {
    /**
     * Get an existing Redirect 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?: RedirectState, opts?: pulumi.CustomResourceOptions): Redirect {
        return new Redirect(name, <any>state, { ...opts, id: id });
    }

    /** @internal */
    public static readonly __pulumiType = 'dokploy:index/redirect:Redirect';

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

    /**
     * Application this redirect belongs to.
     */
    declare public readonly applicationId: pulumi.Output<string>;
    /**
     * RFC 3339 timestamp of when the redirect was created.
     */
    declare public /*out*/ readonly createdAt: pulumi.Output<string>;
    /**
     * Issue a permanent (301) redirect instead of a temporary (302) one.
     */
    declare public readonly permanent: pulumi.Output<boolean>;
    /**
     * Regular expression matched against the incoming URL.
     */
    declare public readonly regex: pulumi.Output<string>;
    /**
     * Replacement URL, which may reference capture groups such as `${1}`.
     */
    declare public readonly replacement: pulumi.Output<string>;

    /**
     * Create a Redirect 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: RedirectArgs, opts?: pulumi.CustomResourceOptions)
    constructor(name: string, argsOrState?: RedirectArgs | RedirectState, opts?: pulumi.CustomResourceOptions) {
        let resourceInputs: pulumi.Inputs = {};
        opts = opts || {};
        if (opts.id) {
            const state = argsOrState as RedirectState | undefined;
            resourceInputs["applicationId"] = state?.applicationId;
            resourceInputs["createdAt"] = state?.createdAt;
            resourceInputs["permanent"] = state?.permanent;
            resourceInputs["regex"] = state?.regex;
            resourceInputs["replacement"] = state?.replacement;
        } else {
            const args = argsOrState as RedirectArgs | undefined;
            if (args?.applicationId === undefined && !opts.urn) {
                throw new Error("Missing required property 'applicationId'");
            }
            if (args?.regex === undefined && !opts.urn) {
                throw new Error("Missing required property 'regex'");
            }
            if (args?.replacement === undefined && !opts.urn) {
                throw new Error("Missing required property 'replacement'");
            }
            resourceInputs["applicationId"] = args?.applicationId;
            resourceInputs["permanent"] = args?.permanent;
            resourceInputs["regex"] = args?.regex;
            resourceInputs["replacement"] = args?.replacement;
            resourceInputs["createdAt"] = undefined /*out*/;
        }
        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
        super(Redirect.__pulumiType, name, resourceInputs, opts);
    }
}

/**
 * Input properties used for looking up and filtering Redirect resources.
 */
export interface RedirectState {
    /**
     * Application this redirect belongs to.
     */
    applicationId?: pulumi.Input<string | undefined>;
    /**
     * RFC 3339 timestamp of when the redirect was created.
     */
    createdAt?: pulumi.Input<string | undefined>;
    /**
     * Issue a permanent (301) redirect instead of a temporary (302) one.
     */
    permanent?: pulumi.Input<boolean | undefined>;
    /**
     * Regular expression matched against the incoming URL.
     */
    regex?: pulumi.Input<string | undefined>;
    /**
     * Replacement URL, which may reference capture groups such as `${1}`.
     */
    replacement?: pulumi.Input<string | undefined>;
}

/**
 * The set of arguments for constructing a Redirect resource.
 */
export interface RedirectArgs {
    /**
     * Application this redirect belongs to.
     */
    applicationId: pulumi.Input<string>;
    /**
     * Issue a permanent (301) redirect instead of a temporary (302) one.
     */
    permanent?: pulumi.Input<boolean | undefined>;
    /**
     * Regular expression matched against the incoming URL.
     */
    regex: pulumi.Input<string>;
    /**
     * Replacement URL, which may reference capture groups such as `${1}`.
     */
    replacement: pulumi.Input<string>;
}