@pulumi/tailscale/deviceKey.d.ts

A Pulumi package for creating and managing Tailscale cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * The deviceKey resource allows you to update the properties of a device's key
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as tailscale from "@pulumi/tailscale";
 *
 * const exampleDevice = tailscale.getDevice({
 *     name: "device.example.com",
 * });
 * const exampleKey = new tailscale.DeviceKey("example_key", {
 *     deviceId: exampleDevice.then(exampleDevice => exampleDevice.nodeId),
 *     keyExpiryDisabled: true,
 * });
 * ```
 *
 * ## Import
 *
 * Device key can be imported using the node ID (preferred), e.g.,
 *
 * ```sh
 * $ pulumi import tailscale:index/deviceKey:DeviceKey sample nodeidCNTRL
 * ```
 *
 * Device key can be imported using the legacy ID, e.g.,
 *
 * ```sh
 * $ pulumi import tailscale:index/deviceKey:DeviceKey sample 123456789
 * ```
 */
export declare class DeviceKey extends pulumi.CustomResource {
    /**
     * Get an existing DeviceKey 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?: DeviceKeyState, opts?: pulumi.CustomResourceOptions): DeviceKey;
    /**
     * Returns true if the given object is an instance of DeviceKey.  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 DeviceKey;
    /**
     * The device to update the key properties of
     */
    readonly deviceId: pulumi.Output<string>;
    /**
     * Determines whether or not the device's key will expire. Defaults to `false`.
     */
    readonly keyExpiryDisabled: pulumi.Output<boolean | undefined>;
    /**
     * Create a DeviceKey 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: DeviceKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering DeviceKey resources.
 */
export interface DeviceKeyState {
    /**
     * The device to update the key properties of
     */
    deviceId?: pulumi.Input<string>;
    /**
     * Determines whether or not the device's key will expire. Defaults to `false`.
     */
    keyExpiryDisabled?: pulumi.Input<boolean>;
}
/**
 * The set of arguments for constructing a DeviceKey resource.
 */
export interface DeviceKeyArgs {
    /**
     * The device to update the key properties of
     */
    deviceId: pulumi.Input<string>;
    /**
     * Determines whether or not the device's key will expire. Defaults to `false`.
     */
    keyExpiryDisabled?: pulumi.Input<boolean>;
}