@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
117 lines (116 loc) • 4.94 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource `equinix.networkedge.SshKey` allows creation and management of Equinix Network Edge SSH keys.
*
* ## Example Usage
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const john = new equinix.networkedge.SshKey("john", {
* name: "johnKent",
* publicKey: " ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDpXGdxljAyPp9vH97436U171cX 2gRkfPnpL8ebrk7ZBeeIpdjtd8mYpXf6fOI0o91TQXZTYtjABzeRgg6/m9hsMOnTHjzWpFyuj/hiPu iie1WtT4NffSH1ALQFX/azouBLmdNiYFMLfEVPZleergAqsYOHGCiQuR6Qh5j0yc5Wx+LKxiRZyjsS qo+EB8V6xBXi2i5PDJXK+dYG8YU9vdNeQdB84HvTWcGEnLR5w7pgC74pBVwzs3oWLy+3jWS0TKKtfl mryeFRufXq87gEkC1MOWX88uQgjyCsemuhPdN++2WS57gu7vcqCMwMDZa7dukRS3JANBtbs7qQhp9N w2PB4q6tohqUnSDxNjCqcoGeMNg/0kHeZcoVuznsjOrIDt0HgUApflkbtw1DP7Epfc2MJ0anf5GizM 8UjMYiXEvv2U/qu8Vb7d5bxAshXM5nh67NSrgst9YzSSodjUCnFQkniz6KLrTkX6c2y2gJ5c9tWhg5 SPkAc8OqLrmIwf5jGoHGh6eUJy7AtMcwE3iUpbrLw8EEoZDoDXkzh+RbOtSNKXWV4EAXsIhjQusCOW WQnuAHCy9N4Td0Sntzu/xhCZ8xN0oO67Cqlsk98xSRLXeg21PuuhOYJw0DLF6L68zU2OO0RzqoNq/F jIsltSUJPAIfYKL0yEefeNWOXSrasI1ezw== John.Kent@company.com\n",
* type: "RSA",
* projectId: "a86d7112-d740-4758-9c9c-31e66373746b",
* });
* ```
*
* ## Import
*
* This resource can be imported using an existing ID:
*
* ```sh
* $ pulumi import equinix:networkedge/sshKey:SshKey example {existing_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 name of SSH key used for identification.
*/
readonly name: pulumi.Output<string>;
/**
* Unique Identifier for the project resource where the SSH key is scoped to.If you leave it out, the ssh key will be created under the default project id of your organization.
*/
readonly projectId: pulumi.Output<string>;
/**
* The SSH public key. If this is a file, it can be read using the file interpolation function.
*/
readonly publicKey: pulumi.Output<string>;
/**
* The type of SSH key: `RSA` (default) or `DSA`.
*/
readonly type: pulumi.Output<string | undefined>;
/**
* The unique identifier of the key
*/
readonly uuid: 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 name of SSH key used for identification.
*/
name?: pulumi.Input<string>;
/**
* Unique Identifier for the project resource where the SSH key is scoped to.If you leave it out, the ssh key will be created under the default project id of your organization.
*/
projectId?: pulumi.Input<string>;
/**
* The SSH public key. If this is a file, it can be read using the file interpolation function.
*/
publicKey?: pulumi.Input<string>;
/**
* The type of SSH key: `RSA` (default) or `DSA`.
*/
type?: pulumi.Input<string>;
/**
* The unique identifier of the key
*/
uuid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SshKey resource.
*/
export interface SshKeyArgs {
/**
* The name of SSH key used for identification.
*/
name?: pulumi.Input<string>;
/**
* Unique Identifier for the project resource where the SSH key is scoped to.If you leave it out, the ssh key will be created under the default project id of your organization.
*/
projectId?: pulumi.Input<string>;
/**
* The SSH public key. If this is a file, it can be read using the file interpolation function.
*/
publicKey: pulumi.Input<string>;
/**
* The type of SSH key: `RSA` (default) or `DSA`.
*/
type?: pulumi.Input<string>;
}