pulumi-dokploy/sdk/nodejs/sshKey.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 SSH key pair Dokploy uses to clone private Git repositories and to reach remote servers.
 *
 * > The private key is stored in Terraform state. Use a state backend with encryption at rest.
 *
 * > Dokploy's update endpoint only accepts `name` and `description`. Changing either key forces a new resource.
 */
export class SshKey extends pulumi.CustomResource {
    /**
     * Get an existing SshKey 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?: SshKeyState, opts?: pulumi.CustomResourceOptions): SshKey {
        return new SshKey(name, <any>state, { ...opts, id: id });
    }

    /** @internal */
    public static readonly __pulumiType = 'dokploy:index/sshKey:SshKey';

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

    /**
     * RFC 3339 timestamp of when the key was created.
     */
    declare public /*out*/ readonly createdAt: pulumi.Output<string>;
    /**
     * Free-form description.
     */
    declare public readonly description: pulumi.Output<string | undefined>;
    /**
     * RFC 3339 timestamp of when the key was last used, if ever.
     */
    declare public /*out*/ readonly lastUsedAt: pulumi.Output<string>;
    /**
     * Display name of the key pair.
     */
    declare public readonly name: pulumi.Output<string>;
    /**
     * PEM-encoded private key.
     */
    declare public readonly privateKey: pulumi.Output<string>;
    /**
     * OpenSSH-formatted public key.
     */
    declare public readonly publicKey: pulumi.Output<string>;

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

/**
 * Input properties used for looking up and filtering SshKey resources.
 */
export interface SshKeyState {
    /**
     * RFC 3339 timestamp of when the key was created.
     */
    createdAt?: pulumi.Input<string | undefined>;
    /**
     * Free-form description.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * RFC 3339 timestamp of when the key was last used, if ever.
     */
    lastUsedAt?: pulumi.Input<string | undefined>;
    /**
     * Display name of the key pair.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * PEM-encoded private key.
     */
    privateKey?: pulumi.Input<string | undefined>;
    /**
     * OpenSSH-formatted public key.
     */
    publicKey?: pulumi.Input<string | undefined>;
}

/**
 * The set of arguments for constructing a SshKey resource.
 */
export interface SshKeyArgs {
    /**
     * Free-form description.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * Display name of the key pair.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * PEM-encoded private key.
     */
    privateKey: pulumi.Input<string>;
    /**
     * OpenSSH-formatted public key.
     */
    publicKey: pulumi.Input<string>;
}