@pulumi/fastly/user.d.ts

A Pulumi package for creating and managing fastly cloud resources.. Based on terraform-provider-fastly: version v4

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a Fastly User, representing the configuration for a user account for interacting with Fastly.
 *
 * The User resource requires a login and name, and optionally a role.
 *
 * ## Example Usage
 *
 * Basic usage:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as fastly from "@pulumi/fastly";
 *
 * const demo = new fastly.User("demo", {
 *     login: "demo@example.com",
 *     name: "Demo User",
 * });
 * ```
 *
 * ## Import
 *
 * A Fastly User can be imported using their user ID, e.g.
 *
 * ```sh
 * $ pulumi import fastly:index/user:User demo xxxxxxxxxxxxxxxxxxxx
 * ```
 */
export declare class User extends pulumi.CustomResource {
    /**
     * Get an existing User 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?: UserState, opts?: pulumi.CustomResourceOptions): User;
    /**
     * Returns true if the given object is an instance of User.  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 User;
    /**
     * The email address, which is the login name, of the User
     */
    readonly login: pulumi.Output<string>;
    /**
     * The real life name of the user
     */
    readonly name: pulumi.Output<string>;
    /**
     * The role of this user. Can be `user` (the default), `billing`, `engineer`, or `superuser`. For detailed information on the abilities granted to each role, see [Fastly's Documentation on User roles](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions#user-roles-and-what-they-can-do)
     */
    readonly role: pulumi.Output<string | undefined>;
    /**
     * Create a User 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: UserArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering User resources.
 */
export interface UserState {
    /**
     * The email address, which is the login name, of the User
     */
    login?: pulumi.Input<string>;
    /**
     * The real life name of the user
     */
    name?: pulumi.Input<string>;
    /**
     * The role of this user. Can be `user` (the default), `billing`, `engineer`, or `superuser`. For detailed information on the abilities granted to each role, see [Fastly's Documentation on User roles](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions#user-roles-and-what-they-can-do)
     */
    role?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a User resource.
 */
export interface UserArgs {
    /**
     * The email address, which is the login name, of the User
     */
    login: pulumi.Input<string>;
    /**
     * The real life name of the user
     */
    name?: pulumi.Input<string>;
    /**
     * The role of this user. Can be `user` (the default), `billing`, `engineer`, or `superuser`. For detailed information on the abilities granted to each role, see [Fastly's Documentation on User roles](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions#user-roles-and-what-they-can-do)
     */
    role?: pulumi.Input<string>;
}