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

/**
 * An environment inside a Dokploy project, such as `staging` or `production`. Services belong to an environment rather than directly to a project.
 *
 * Dokploy creates a default `production` environment with every project; reference it via `dokploy_project.<name>.default_environment_id` instead of declaring it here.
 */
export class Environment extends pulumi.CustomResource {
    /**
     * Get an existing Environment 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?: EnvironmentState, opts?: pulumi.CustomResourceOptions): Environment {
        return new Environment(name, <any>state, { ...opts, id: id });
    }

    /** @internal */
    public static readonly __pulumiType = 'dokploy:index/environment:Environment';

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

    /**
     * RFC 3339 timestamp of when the environment was created.
     */
    declare public /*out*/ readonly createdAt: pulumi.Output<string>;
    /**
     * Free-form description.
     */
    declare public readonly description: pulumi.Output<string | undefined>;
    /**
     * Environment-wide variables in `KEY=value` format, one per line. These are merged into every service in this environment.
     */
    declare public readonly env: pulumi.Output<string>;
    /**
     * Whether this is the project's default environment.
     */
    declare public /*out*/ readonly isDefault: pulumi.Output<boolean>;
    /**
     * Environment name, for example `staging`.
     */
    declare public readonly name: pulumi.Output<string>;
    /**
     * Project this environment belongs to.
     */
    declare public readonly projectId: pulumi.Output<string>;

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

/**
 * Input properties used for looking up and filtering Environment resources.
 */
export interface EnvironmentState {
    /**
     * RFC 3339 timestamp of when the environment was created.
     */
    createdAt?: pulumi.Input<string | undefined>;
    /**
     * Free-form description.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * Environment-wide variables in `KEY=value` format, one per line. These are merged into every service in this environment.
     */
    env?: pulumi.Input<string | undefined>;
    /**
     * Whether this is the project's default environment.
     */
    isDefault?: pulumi.Input<boolean | undefined>;
    /**
     * Environment name, for example `staging`.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Project this environment belongs to.
     */
    projectId?: pulumi.Input<string | undefined>;
}

/**
 * The set of arguments for constructing a Environment resource.
 */
export interface EnvironmentArgs {
    /**
     * Free-form description.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * Environment-wide variables in `KEY=value` format, one per line. These are merged into every service in this environment.
     */
    env?: pulumi.Input<string | undefined>;
    /**
     * Environment name, for example `staging`.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Project this environment belongs to.
     */
    projectId: pulumi.Input<string>;
}