@equinix-labs/pulumi-equinix/metal/sshKey.d.ts

A Pulumi package for creating and managing equinix cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a resource to manage User SSH keys on your Equinix Metal user account. If you create a new device in a project, all the keys of the project's collaborators will be injected to the device.
 *
 * The link between User SSH key and device is implicit. If you want to make sure that a key will be copied to a device, you must ensure that the device resource `dependsOn` the key resource.
 *
 * ## Example Usage
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as equinix from "@equinix-labs/pulumi-equinix";
 * import * as std from "@pulumi/std";
 *
 * const key1 = new equinix.metal.SshKey("key1", {
 *     name: "terraform-1",
 *     publicKey: std.fileOutput({
 *         input: "/home/terraform/.ssh/id_rsa.pub",
 *     }).apply(invoke => invoke.result),
 * });
 * const test = new equinix.metal.Device("test", {
 *     hostname: "test-device",
 *     plan: equinix.metal.Plan.C3SmallX86,
 *     metro: "sv",
 *     operatingSystem: equinix.metal.OperatingSystem.Ubuntu20_04,
 *     billingCycle: equinix.metal.BillingCycle.Hourly,
 *     projectId: projectId,
 * }, {
 *     dependsOn: [key1],
 * });
 * ```
 *
 * ## Import
 *
 * This resource can be imported using an existing SSH Key ID:
 *
 * ```sh
 * $ pulumi import equinix:metal/sshKey:SshKey equinix_metal_ssh_key {existing_sshkey_id}
 * ```
 */
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: SshKeyState, opts?: pulumi.CustomResourceOptions): 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.
     */
    static isInstance(obj: any): obj is SshKey;
    /**
     * The timestamp for when the SSH key was created.
     */
    readonly created: pulumi.Output<string>;
    /**
     * The fingerprint of the SSH key.
     */
    readonly fingerprint: pulumi.Output<string>;
    /**
     * The name of the SSH key for identification
     */
    readonly name: pulumi.Output<string>;
    /**
     * The UUID of the Equinix Metal API User who owns this key.
     */
    readonly ownerId: pulumi.Output<string>;
    /**
     * The public key. If this is a file, it can be read using the file interpolation function
     */
    readonly publicKey: pulumi.Output<string>;
    /**
     * The timestamp for the last time the SSH key was updated.
     */
    readonly updated: 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);
}
/**
 * Input properties used for looking up and filtering SshKey resources.
 */
export interface SshKeyState {
    /**
     * The timestamp for when the SSH key was created.
     */
    created?: pulumi.Input<string>;
    /**
     * The fingerprint of the SSH key.
     */
    fingerprint?: pulumi.Input<string>;
    /**
     * The name of the SSH key for identification
     */
    name?: pulumi.Input<string>;
    /**
     * The UUID of the Equinix Metal API User who owns this key.
     */
    ownerId?: pulumi.Input<string>;
    /**
     * The public key. If this is a file, it can be read using the file interpolation function
     */
    publicKey?: pulumi.Input<string>;
    /**
     * The timestamp for the last time the SSH key was updated.
     */
    updated?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a SshKey resource.
 */
export interface SshKeyArgs {
    /**
     * The name of the SSH key for identification
     */
    name?: pulumi.Input<string>;
    /**
     * The public key. If this is a file, it can be read using the file interpolation function
     */
    publicKey: pulumi.Input<string>;
}