@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
198 lines (197 loc) • 5.74 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = new meraki.organizations.Admins("example", {
* authenticationMethod: "Email",
* email: "miles@meraki.com",
* name: "Miles Meraki",
* networks: [{
* access: "full",
* id: "N_24329156",
* }],
* orgAccess: "none",
* organizationId: "string",
* tags: [{
* access: "read-only",
* tag: "west",
* }],
* });
* export const merakiOrganizationsAdminsExample = example;
* ```
*
* ## Import
*
* ```sh
* $ pulumi import meraki:organizations/admins:Admins example "organization_id"
* ```
*/
export declare class Admins extends pulumi.CustomResource {
/**
* Get an existing Admins 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?: AdminsState, opts?: pulumi.CustomResourceOptions): Admins;
/**
* Returns true if the given object is an instance of Admins. 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 Admins;
/**
* Status of the admin's account
*/
readonly accountStatus: pulumi.Output<string>;
/**
* adminId path parameter. Admin ID
*/
readonly adminId: pulumi.Output<string | undefined>;
/**
* Admin's authentication method
*/
readonly authenticationMethod: pulumi.Output<string>;
/**
* Admin's email address
*/
readonly email: pulumi.Output<string>;
/**
* Indicates whether the admin has an API key
*/
readonly hasApiKey: pulumi.Output<boolean>;
/**
* Time when the admin was last active
*/
readonly lastActive: pulumi.Output<string>;
/**
* Admin's username
*/
readonly name: pulumi.Output<string>;
/**
* Admin network access information
*/
readonly networks: pulumi.Output<outputs.organizations.AdminsNetwork[]>;
/**
* Admin's level of access to the organization
*/
readonly orgAccess: pulumi.Output<string>;
/**
* organizationId path parameter. Organization ID
*/
readonly organizationId: pulumi.Output<string>;
/**
* Admin tag information
*/
readonly tags: pulumi.Output<outputs.organizations.AdminsTag[]>;
/**
* Indicates whether two-factor authentication is enabled
*/
readonly twoFactorAuthEnabled: pulumi.Output<boolean>;
/**
* Create a Admins 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: AdminsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Admins resources.
*/
export interface AdminsState {
/**
* Status of the admin's account
*/
accountStatus?: pulumi.Input<string>;
/**
* adminId path parameter. Admin ID
*/
adminId?: pulumi.Input<string>;
/**
* Admin's authentication method
*/
authenticationMethod?: pulumi.Input<string>;
/**
* Admin's email address
*/
email?: pulumi.Input<string>;
/**
* Indicates whether the admin has an API key
*/
hasApiKey?: pulumi.Input<boolean>;
/**
* Time when the admin was last active
*/
lastActive?: pulumi.Input<string>;
/**
* Admin's username
*/
name?: pulumi.Input<string>;
/**
* Admin network access information
*/
networks?: pulumi.Input<pulumi.Input<inputs.organizations.AdminsNetwork>[]>;
/**
* Admin's level of access to the organization
*/
orgAccess?: pulumi.Input<string>;
/**
* organizationId path parameter. Organization ID
*/
organizationId?: pulumi.Input<string>;
/**
* Admin tag information
*/
tags?: pulumi.Input<pulumi.Input<inputs.organizations.AdminsTag>[]>;
/**
* Indicates whether two-factor authentication is enabled
*/
twoFactorAuthEnabled?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a Admins resource.
*/
export interface AdminsArgs {
/**
* adminId path parameter. Admin ID
*/
adminId?: pulumi.Input<string>;
/**
* Admin's authentication method
*/
authenticationMethod?: pulumi.Input<string>;
/**
* Admin's email address
*/
email?: pulumi.Input<string>;
/**
* Admin's username
*/
name?: pulumi.Input<string>;
/**
* Admin network access information
*/
networks?: pulumi.Input<pulumi.Input<inputs.organizations.AdminsNetwork>[]>;
/**
* Admin's level of access to the organization
*/
orgAccess?: pulumi.Input<string>;
/**
* organizationId path parameter. Organization ID
*/
organizationId: pulumi.Input<string>;
/**
* Admin tag information
*/
tags?: pulumi.Input<pulumi.Input<inputs.organizations.AdminsTag>[]>;
}