@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
130 lines (129 loc) • 5.17 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides an Equinix Metal project SSH key resource to manage project-specific SSH keys. Project SSH keys will only be populated onto servers that belong to that project, in contrast to User SSH Keys.
*
* ## Example Usage
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const projectId = "<UUID_of_your_project>";
* const test = new equinix.metal.ProjectSshKey("test", {
* name: "test",
* publicKey: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDM/unxJeFqxsTJcu6mhqsMHSaVlpu+Jj/P+44zrm6X/MAoHSX3X9oLgujEjjZ74yLfdfe0bJrbL2YgJzNaEkIQQ1VPMHB5EhTKUBGnzlPP0hHTnxsjAm9qDHgUPgvgFDQSAMzdJRJ0Cexo16Ph9VxCoLh3dxiE7s2gaM2FdVg7P8aSxKypsxAhYV3D0AwqzoOyT6WWhBoQ0xZ85XevOTnJCpImSemEGs6nVGEsWcEc1d1YvdxFjAK4SdsKUMkj4Dsy/leKsdi/DEAf356vbMT1UHsXXvy5TlHu/Pa6qF53v32Enz+nhKy7/8W2Yt2yWx8HnQcT2rug9lvCXagJO6oauqRTO77C4QZn13ZLMZgLT66S/tNh2EX0gi6vmIs5dth8uF+K6nxIyKJXbcA4ASg7F1OJrHKFZdTc5v1cPeq6PcbqGgc+8SrPYQmzvQqLoMBuxyos2hUkYOmw3aeWJj9nFa8Wu5WaN89mUeOqSkU4S5cgUzWUOmKey56B/j/s1sVys9rMhZapVs0wL4L9GBBM48N5jAQZnnpo85A8KsZq5ME22bTLqnxsDXqDYZvS7PSI6Dxi7eleOFE/NYYDkrgDLHTQri8ucDMVeVWHgoMY2bPXdn7KKy5jW5jKsf8EPARXg77A4gRYmgKrcwIKqJEUPqyxJBe0CPoGTqgXPRsUiQ== tomk@hp2",
* projectId: projectId,
* });
* const testDevice = new equinix.metal.Device("testDevice", {
* hostname: "test",
* plan: equinix.metal.Plan.C3MediumX86,
* metro: "ny",
* operatingSystem: equinix.metal.OperatingSystem.Ubuntu20_04,
* billingCycle: equinix.metal.BillingCycle.Hourly,
* projectSshKeyIds: [test.id],
* projectId: projectId,
* });
* ```
*/
export declare class ProjectSshKey extends pulumi.CustomResource {
/**
* Get an existing ProjectSshKey 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?: ProjectSshKeyState, opts?: pulumi.CustomResourceOptions): ProjectSshKey;
/**
* Returns true if the given object is an instance of ProjectSshKey. 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 ProjectSshKey;
/**
* 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 ID of parent project (same as project_id).
*/
readonly ownerId: pulumi.Output<string>;
/**
* The ID of parent project.
*/
readonly projectId: 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 ProjectSshKey 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: ProjectSshKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ProjectSshKey resources.
*/
export interface ProjectSshKeyState {
/**
* 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 ID of parent project (same as project_id).
*/
ownerId?: pulumi.Input<string>;
/**
* The ID of parent project.
*/
projectId?: 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 ProjectSshKey resource.
*/
export interface ProjectSshKeyArgs {
/**
* The name of the SSH key for identification.
*/
name?: pulumi.Input<string>;
/**
* The ID of parent project.
*/
projectId: pulumi.Input<string>;
/**
* The public key. If this is a file, it can be read using the file interpolation function.
*/
publicKey: pulumi.Input<string>;
}