UNPKG

@equinix-labs/pulumi-equinix

Version:

A Pulumi package for creating and managing equinix cloud resources.

107 lines (106 loc) 3.28 kB
import * as pulumi from "@pulumi/pulumi"; /** * Resource `equinix.networkedge.SshUser` allows creation and management of Equinix Network Edge SSH users. * * ## Example Usage * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as equinix from "@equinix-labs/pulumi-equinix"; * * const john = new equinix.networkedge.SshUser("john", { * username: "john", * password: "secret", * deviceIds: [ * "csr1000v-ha-uuid", * "csr1000v-ha-redundant-uuid", * ], * }); * ``` * * ## Import * * This resource can be imported using an existing ID: * * ```sh * $ pulumi import equinix:networkedge/sshUser:SshUser example {existing_id} * ``` */ export declare class SshUser extends pulumi.CustomResource { /** * Get an existing SshUser 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?: SshUserState, opts?: pulumi.CustomResourceOptions): SshUser; /** * Returns true if the given object is an instance of SshUser. 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 SshUser; /** * list of device identifiers to which user will have access. */ readonly deviceIds: pulumi.Output<string[]>; /** * SSH user password. */ readonly password: pulumi.Output<string>; /** * SSH user login name. */ readonly username: pulumi.Output<string>; /** * SSH user unique identifier. */ readonly uuid: pulumi.Output<string>; /** * Create a SshUser 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: SshUserArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering SshUser resources. */ export interface SshUserState { /** * list of device identifiers to which user will have access. */ deviceIds?: pulumi.Input<pulumi.Input<string>[]>; /** * SSH user password. */ password?: pulumi.Input<string>; /** * SSH user login name. */ username?: pulumi.Input<string>; /** * SSH user unique identifier. */ uuid?: pulumi.Input<string>; } /** * The set of arguments for constructing a SshUser resource. */ export interface SshUserArgs { /** * list of device identifiers to which user will have access. */ deviceIds: pulumi.Input<pulumi.Input<string>[]>; /** * SSH user password. */ password: pulumi.Input<string>; /** * SSH user login name. */ username: pulumi.Input<string>; }