pulumi-dokploy/sdk/nodejs/registry.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 container registry that Dokploy pushes built images to and pulls them from.
 */
export class Registry extends pulumi.CustomResource {
    /**
     * Get an existing Registry 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?: RegistryState, opts?: pulumi.CustomResourceOptions): Registry {
        return new Registry(name, <any>state, { ...opts, id: id });
    }

    /** @internal */
    public static readonly __pulumiType = 'dokploy:index/registry:Registry';

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

    /**
     * RFC 3339 timestamp of when the registry was created.
     */
    declare public /*out*/ readonly createdAt: pulumi.Output<string>;
    /**
     * Prefix prepended to pushed image names, for example an organization or namespace.
     */
    declare public readonly imagePrefix: pulumi.Output<string | undefined>;
    /**
     * Password or access token used to authenticate.
     */
    declare public readonly password: pulumi.Output<string>;
    /**
     * Display name of the registry.
     */
    declare public readonly registryName: pulumi.Output<string>;
    /**
     * Registry kind. Dokploy currently accepts only `cloud`. Valid values: `cloud`. Defaults to `cloud`.
     */
    declare public readonly registryType: pulumi.Output<string>;
    /**
     * Registry hostname, for example `ghcr.io`.
     */
    declare public readonly registryUrl: pulumi.Output<string>;
    /**
     * Server this registry is scoped to.
     */
    declare public readonly serverId: pulumi.Output<string | undefined>;
    /**
     * Username used to authenticate to the registry.
     */
    declare public readonly username: pulumi.Output<string>;

    /**
     * Create a Registry 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: RegistryArgs, opts?: pulumi.CustomResourceOptions)
    constructor(name: string, argsOrState?: RegistryArgs | RegistryState, opts?: pulumi.CustomResourceOptions) {
        let resourceInputs: pulumi.Inputs = {};
        opts = opts || {};
        if (opts.id) {
            const state = argsOrState as RegistryState | undefined;
            resourceInputs["createdAt"] = state?.createdAt;
            resourceInputs["imagePrefix"] = state?.imagePrefix;
            resourceInputs["password"] = state?.password;
            resourceInputs["registryName"] = state?.registryName;
            resourceInputs["registryType"] = state?.registryType;
            resourceInputs["registryUrl"] = state?.registryUrl;
            resourceInputs["serverId"] = state?.serverId;
            resourceInputs["username"] = state?.username;
        } else {
            const args = argsOrState as RegistryArgs | undefined;
            if (args?.password === undefined && !opts.urn) {
                throw new Error("Missing required property 'password'");
            }
            if (args?.registryName === undefined && !opts.urn) {
                throw new Error("Missing required property 'registryName'");
            }
            if (args?.registryUrl === undefined && !opts.urn) {
                throw new Error("Missing required property 'registryUrl'");
            }
            if (args?.username === undefined && !opts.urn) {
                throw new Error("Missing required property 'username'");
            }
            resourceInputs["imagePrefix"] = args?.imagePrefix;
            resourceInputs["password"] = args?.password ? pulumi.secret(args.password) : undefined;
            resourceInputs["registryName"] = args?.registryName;
            resourceInputs["registryType"] = args?.registryType;
            resourceInputs["registryUrl"] = args?.registryUrl;
            resourceInputs["serverId"] = args?.serverId;
            resourceInputs["username"] = args?.username;
            resourceInputs["createdAt"] = undefined /*out*/;
        }
        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
        const secretOpts = { additionalSecretOutputs: ["password"] };
        opts = pulumi.mergeOptions(opts, secretOpts);
        super(Registry.__pulumiType, name, resourceInputs, opts);
    }
}

/**
 * Input properties used for looking up and filtering Registry resources.
 */
export interface RegistryState {
    /**
     * RFC 3339 timestamp of when the registry was created.
     */
    createdAt?: pulumi.Input<string | undefined>;
    /**
     * Prefix prepended to pushed image names, for example an organization or namespace.
     */
    imagePrefix?: pulumi.Input<string | undefined>;
    /**
     * Password or access token used to authenticate.
     */
    password?: pulumi.Input<string | undefined>;
    /**
     * Display name of the registry.
     */
    registryName?: pulumi.Input<string | undefined>;
    /**
     * Registry kind. Dokploy currently accepts only `cloud`. Valid values: `cloud`. Defaults to `cloud`.
     */
    registryType?: pulumi.Input<string | undefined>;
    /**
     * Registry hostname, for example `ghcr.io`.
     */
    registryUrl?: pulumi.Input<string | undefined>;
    /**
     * Server this registry is scoped to.
     */
    serverId?: pulumi.Input<string | undefined>;
    /**
     * Username used to authenticate to the registry.
     */
    username?: pulumi.Input<string | undefined>;
}

/**
 * The set of arguments for constructing a Registry resource.
 */
export interface RegistryArgs {
    /**
     * Prefix prepended to pushed image names, for example an organization or namespace.
     */
    imagePrefix?: pulumi.Input<string | undefined>;
    /**
     * Password or access token used to authenticate.
     */
    password: pulumi.Input<string>;
    /**
     * Display name of the registry.
     */
    registryName: pulumi.Input<string>;
    /**
     * Registry kind. Dokploy currently accepts only `cloud`. Valid values: `cloud`. Defaults to `cloud`.
     */
    registryType?: pulumi.Input<string | undefined>;
    /**
     * Registry hostname, for example `ghcr.io`.
     */
    registryUrl: pulumi.Input<string>;
    /**
     * Server this registry is scoped to.
     */
    serverId?: pulumi.Input<string | undefined>;
    /**
     * Username used to authenticate to the registry.
     */
    username: pulumi.Input<string>;
}