UNPKG

@pulumi/digitalocean

Version:

A Pulumi package for creating and managing DigitalOcean cloud resources.

94 lines 3.43 kB
"use strict"; // *** WARNING: this file was generated by pulumi-language-nodejs. *** // *** Do not edit by hand unless you're certain you know what you are doing! *** Object.defineProperty(exports, "__esModule", { value: true }); exports.SshKey = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("./utilities"); /** * Provides a DigitalOcean SSH key resource to allow you to manage SSH * keys for Droplet access. Keys created with this resource * can be referenced in your Droplet configuration via their ID or * fingerprint. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as digitalocean from "@pulumi/digitalocean"; * import * as std from "@pulumi/std"; * * // Create a new SSH key * const _default = new digitalocean.SshKey("default", { * name: "Example", * publicKey: std.file({ * input: "/Users/myuser/.ssh/id_rsa.pub", * }).then(invoke => invoke.result), * }); * // Create a new Droplet using the SSH key * const web = new digitalocean.Droplet("web", { * image: "ubuntu-18-04-x64", * name: "web-1", * region: digitalocean.Region.NYC3, * size: digitalocean.DropletSlug.DropletS1VCPU1GB, * sshKeys: [_default.fingerprint], * }); * ``` * * ## Import * * SSH Keys can be imported using the `ssh key id`, e.g. * * ```sh * $ pulumi import digitalocean:index/sshKey:SshKey mykey 263654 * ``` */ 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. */ static get(name, id, state, opts) { return new SshKey(name, state, { ...opts, id: id }); } /** * 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. */ static isInstance(obj) { if (obj === undefined || obj === null) { return false; } return obj['__pulumiType'] === SshKey.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["fingerprint"] = state?.fingerprint; resourceInputs["name"] = state?.name; resourceInputs["publicKey"] = state?.publicKey; } else { const args = argsOrState; if (args?.publicKey === undefined && !opts.urn) { throw new Error("Missing required property 'publicKey'"); } resourceInputs["name"] = args?.name; resourceInputs["publicKey"] = args?.publicKey; resourceInputs["fingerprint"] = undefined /*out*/; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(SshKey.__pulumiType, name, resourceInputs, opts); } } exports.SshKey = SshKey; /** @internal */ SshKey.__pulumiType = 'digitalocean:index/sshKey:SshKey'; //# sourceMappingURL=sshKey.js.map