UNPKG

@pulumi/meraki

Version:

A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0

164 lines (163 loc) 5.24 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * ## Example Usage * * ## Import * * ```sh * $ pulumi import meraki:networks/merakiAuthUsers:MerakiAuthUsers example "meraki_auth_user_id,network_id" * ``` */ export declare class MerakiAuthUsers extends pulumi.CustomResource { /** * Get an existing MerakiAuthUsers 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?: MerakiAuthUsersState, opts?: pulumi.CustomResourceOptions): MerakiAuthUsers; /** * Returns true if the given object is an instance of MerakiAuthUsers. 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 MerakiAuthUsers; /** * Authorization type for user. */ readonly accountType: pulumi.Output<string>; /** * User authorization info */ readonly authorizations: pulumi.Output<outputs.networks.MerakiAuthUsersAuthorization[]>; /** * Creation time of the user */ readonly createdAt: pulumi.Output<string>; /** * Email address of the user */ readonly email: pulumi.Output<string>; /** * Whether or not Meraki should email the password to user. Default is false. */ readonly emailPasswordToUser: pulumi.Output<boolean>; /** * Whether or not the user is a Dashboard administrator */ readonly isAdmin: pulumi.Output<boolean>; /** * merakiAuthUserId path parameter. Meraki auth user ID */ readonly merakiAuthUserId: pulumi.Output<string | undefined>; /** * Name of the user */ readonly name: pulumi.Output<string>; /** * networkId path parameter. Network ID */ readonly networkId: pulumi.Output<string>; /** * The password for this user account. Only required If the user is not a Dashboard administrator. */ readonly password: pulumi.Output<string>; /** * Create a MerakiAuthUsers 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: MerakiAuthUsersArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering MerakiAuthUsers resources. */ export interface MerakiAuthUsersState { /** * Authorization type for user. */ accountType?: pulumi.Input<string>; /** * User authorization info */ authorizations?: pulumi.Input<pulumi.Input<inputs.networks.MerakiAuthUsersAuthorization>[]>; /** * Creation time of the user */ createdAt?: pulumi.Input<string>; /** * Email address of the user */ email?: pulumi.Input<string>; /** * Whether or not Meraki should email the password to user. Default is false. */ emailPasswordToUser?: pulumi.Input<boolean>; /** * Whether or not the user is a Dashboard administrator */ isAdmin?: pulumi.Input<boolean>; /** * merakiAuthUserId path parameter. Meraki auth user ID */ merakiAuthUserId?: pulumi.Input<string>; /** * Name of the user */ name?: pulumi.Input<string>; /** * networkId path parameter. Network ID */ networkId?: pulumi.Input<string>; /** * The password for this user account. Only required If the user is not a Dashboard administrator. */ password?: pulumi.Input<string>; } /** * The set of arguments for constructing a MerakiAuthUsers resource. */ export interface MerakiAuthUsersArgs { /** * Authorization type for user. */ accountType?: pulumi.Input<string>; /** * User authorization info */ authorizations?: pulumi.Input<pulumi.Input<inputs.networks.MerakiAuthUsersAuthorization>[]>; /** * Email address of the user */ email?: pulumi.Input<string>; /** * Whether or not Meraki should email the password to user. Default is false. */ emailPasswordToUser?: pulumi.Input<boolean>; /** * Whether or not the user is a Dashboard administrator */ isAdmin?: pulumi.Input<boolean>; /** * merakiAuthUserId path parameter. Meraki auth user ID */ merakiAuthUserId?: pulumi.Input<string>; /** * Name of the user */ name?: pulumi.Input<string>; /** * networkId path parameter. Network ID */ networkId: pulumi.Input<string>; /** * The password for this user account. Only required If the user is not a Dashboard administrator. */ password?: pulumi.Input<string>; }