UNPKG

@cuemby/equinix

Version:

A Pulumi package for creating and managing equinix cloud resources.

111 lines (110 loc) 3.5 kB
import * as pulumi from "@pulumi/pulumi"; /** * Resource `equinix.NetworkSSHUser` allows creation and management of Equinix Network * Edge SSH users. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as equinix from "@cuemby/equinix"; * * // Create SSH user with password auth method and associate it with * // two virtual network devices * const john = new equinix.NetworkSSHUser("john", { * username: "john", * password: "secret", * deviceIds: [ * equinix_ne_device["csr1000v-ha"].uuid, * equinix_ne_device["csr1000v-ha"].redundant_uuid, * ], * }); * ``` * * ## Import * * This resource can be imported using an existing ID * * ```sh * $ pulumi import equinix:index/networkSSHUser:NetworkSSHUser example {existing_id} * ``` */ export declare class NetworkSSHUser extends pulumi.CustomResource { /** * Get an existing NetworkSSHUser 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?: NetworkSSHUserState, opts?: pulumi.CustomResourceOptions): NetworkSSHUser; /** * Returns true if the given object is an instance of NetworkSSHUser. 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 NetworkSSHUser; /** * 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 NetworkSSHUser 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: NetworkSSHUserArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering NetworkSSHUser resources. */ export interface NetworkSSHUserState { /** * 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 NetworkSSHUser resource. */ export interface NetworkSSHUserArgs { /** * 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>; }