@formalco/pulumi/user.d.ts

A Pulumi package for creating and managing Formal resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * User in Formal.
 */
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;
    /**
     * If the user is of type `machine`, this is an optional designation for the app that this user will be used for. Supported values are `metabase`, `tableau`, and `popsql`.
     */
    readonly appType: pulumi.Output<string | undefined>;
    /**
     * The username that the user will use to access the sidecar.
     */
    readonly dbUsername: pulumi.Output<string>;
    /**
     * For human users, their email.
     */
    readonly email: pulumi.Output<string | undefined>;
    /**
     * When the Role should be deleted and access revoked. Value should be provided in Unix epoch time, in seconds since midnight UTC of January 1, 1970.
     */
    readonly expireAt: pulumi.Output<number | undefined>;
    /**
     * For human users, their first name.
     */
    readonly firstName: pulumi.Output<string | undefined>;
    /**
     * For human users, their last name.
     */
    readonly lastName: pulumi.Output<string | undefined>;
    /**
     * If the user is of type `machine`, this is the access token (database password) of this user.
     */
    readonly machineUserAccessToken: pulumi.Output<string>;
    /**
     * For machine users, the name of the user.
     */
    readonly name: pulumi.Output<string>;
    /**
     * If set to true, this User cannot be deleted.
     */
    readonly terminationProtection: pulumi.Output<boolean | undefined>;
    /**
     * Either 'human' or 'machine'.
     */
    readonly type: pulumi.Output<string>;
    /**
     * 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 {
    /**
     * If the user is of type `machine`, this is an optional designation for the app that this user will be used for. Supported values are `metabase`, `tableau`, and `popsql`.
     */
    appType?: pulumi.Input<string>;
    /**
     * The username that the user will use to access the sidecar.
     */
    dbUsername?: pulumi.Input<string>;
    /**
     * For human users, their email.
     */
    email?: pulumi.Input<string>;
    /**
     * When the Role should be deleted and access revoked. Value should be provided in Unix epoch time, in seconds since midnight UTC of January 1, 1970.
     */
    expireAt?: pulumi.Input<number>;
    /**
     * For human users, their first name.
     */
    firstName?: pulumi.Input<string>;
    /**
     * For human users, their last name.
     */
    lastName?: pulumi.Input<string>;
    /**
     * If the user is of type `machine`, this is the access token (database password) of this user.
     */
    machineUserAccessToken?: pulumi.Input<string>;
    /**
     * For machine users, the name of the user.
     */
    name?: pulumi.Input<string>;
    /**
     * If set to true, this User cannot be deleted.
     */
    terminationProtection?: pulumi.Input<boolean>;
    /**
     * Either 'human' or 'machine'.
     */
    type?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a User resource.
 */
export interface UserArgs {
    /**
     * If the user is of type `machine`, this is an optional designation for the app that this user will be used for. Supported values are `metabase`, `tableau`, and `popsql`.
     */
    appType?: pulumi.Input<string>;
    /**
     * For human users, their email.
     */
    email?: pulumi.Input<string>;
    /**
     * When the Role should be deleted and access revoked. Value should be provided in Unix epoch time, in seconds since midnight UTC of January 1, 1970.
     */
    expireAt?: pulumi.Input<number>;
    /**
     * For human users, their first name.
     */
    firstName?: pulumi.Input<string>;
    /**
     * For human users, their last name.
     */
    lastName?: pulumi.Input<string>;
    /**
     * For machine users, the name of the user.
     */
    name?: pulumi.Input<string>;
    /**
     * If set to true, this User cannot be deleted.
     */
    terminationProtection?: pulumi.Input<boolean>;
    /**
     * Either 'human' or 'machine'.
     */
    type: pulumi.Input<string>;
}