@volcengine/pulumi/ecs/keyPair.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a resource to manage ecs key pair
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@volcengine/pulumi";
 *
 * const foo = new volcengine.ecs.KeyPair("foo", {
 *     description: "acc-test",
 *     keyPairName: "acc-test-key-name",
 * });
 * ```
 *
 * ## Import
 *
 * ECS key pair can be imported using the id, e.g.
 *
 * ```sh
 * $ pulumi import volcengine:ecs/keyPair:KeyPair default kp-mizl7m1kqccg5smt1bdpijuj
 * ```
 */
export declare class KeyPair extends pulumi.CustomResource {
    /**
     * Get an existing KeyPair 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?: KeyPairState, opts?: pulumi.CustomResourceOptions): KeyPair;
    /**
     * Returns true if the given object is an instance of KeyPair.  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 KeyPair;
    /**
     * The description of key pair.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The finger print info.
     */
    readonly fingerPrint: pulumi.Output<string>;
    /**
     * Target file to save private key. It is recommended that the value not be empty. You only have one chance to download the private key, the volcengine will not save your private key, please keep it safe. In the TF import scenario, this field will not write the private key locally.
     */
    readonly keyFile: pulumi.Output<string | undefined>;
    /**
     * The id of key pair.
     */
    readonly keyPairId: pulumi.Output<string>;
    /**
     * The name of key pair.
     */
    readonly keyPairName: pulumi.Output<string>;
    /**
     * Public key string.
     */
    readonly publicKey: pulumi.Output<string | undefined>;
    /**
     * Create a KeyPair 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: KeyPairArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering KeyPair resources.
 */
export interface KeyPairState {
    /**
     * The description of key pair.
     */
    description?: pulumi.Input<string>;
    /**
     * The finger print info.
     */
    fingerPrint?: pulumi.Input<string>;
    /**
     * Target file to save private key. It is recommended that the value not be empty. You only have one chance to download the private key, the volcengine will not save your private key, please keep it safe. In the TF import scenario, this field will not write the private key locally.
     */
    keyFile?: pulumi.Input<string>;
    /**
     * The id of key pair.
     */
    keyPairId?: pulumi.Input<string>;
    /**
     * The name of key pair.
     */
    keyPairName?: pulumi.Input<string>;
    /**
     * Public key string.
     */
    publicKey?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a KeyPair resource.
 */
export interface KeyPairArgs {
    /**
     * The description of key pair.
     */
    description?: pulumi.Input<string>;
    /**
     * Target file to save private key. It is recommended that the value not be empty. You only have one chance to download the private key, the volcengine will not save your private key, please keep it safe. In the TF import scenario, this field will not write the private key locally.
     */
    keyFile?: pulumi.Input<string>;
    /**
     * The name of key pair.
     */
    keyPairName: pulumi.Input<string>;
    /**
     * Public key string.
     */
    publicKey?: pulumi.Input<string>;
}