Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Formal Provider
  3. API Docs
  4. User
Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal
formalco/pulumi-formal

formal.User

Explore with Pulumi AI

formal logo
Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal
formalco/pulumi-formal

    User in Formal.

    Create User Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         type: Optional[str] = None,
         app_type: Optional[str] = None,
         email: Optional[str] = None,
         expire_at: Optional[int] = None,
         first_name: Optional[str] = None,
         last_name: Optional[str] = None,
         name: Optional[str] = None,
         termination_protection: Optional[bool] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: formal:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userResource = new Pulumi.User("userResource", new()
{
    Type = "string",
    AppType = "string",
    Email = "string",
    ExpireAt = 0,
    FirstName = "string",
    LastName = "string",
    Name = "string",
    TerminationProtection = false,
});

    example, err := formal.NewUser(ctx, "userResource", &formal.UserArgs{
	Type:                  pulumi.String("string"),
	AppType:               pulumi.String("string"),
	Email:                 pulumi.String("string"),
	ExpireAt:              pulumi.Int(0),
	FirstName:             pulumi.String("string"),
	LastName:              pulumi.String("string"),
	Name:                  pulumi.String("string"),
	TerminationProtection: pulumi.Bool(false),
})

    var userResource = new User("userResource", UserArgs.builder()
    .type("string")
    .appType("string")
    .email("string")
    .expireAt(0)
    .firstName("string")
    .lastName("string")
    .name("string")
    .terminationProtection(false)
    .build());

    user_resource = formal.User("userResource",
    type="string",
    app_type="string",
    email="string",
    expire_at=0,
    first_name="string",
    last_name="string",
    name="string",
    termination_protection=False)

    const userResource = new formal.User("userResource", {
    type: "string",
    appType: "string",
    email: "string",
    expireAt: 0,
    firstName: "string",
    lastName: "string",
    name: "string",
    terminationProtection: false,
});

    type: formal:User
properties:
    appType: string
    email: string
    expireAt: 0
    firstName: string
    lastName: string
    name: string
    terminationProtection: false
    type: string

    User Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The User resource accepts the following input properties:

    Type string
    Either 'human' or 'machine'.
    AppType string
    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.
    Email string
    For human users, their email.
    ExpireAt int
    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.
    FirstName string
    For human users, their first name.
    LastName string
    For human users, their last name.
    Name string
    For machine users, the name of the user.
    TerminationProtection bool
    If set to true, this User cannot be deleted.
    Type string
    Either 'human' or 'machine'.
    AppType string
    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.
    Email string
    For human users, their email.
    ExpireAt int
    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.
    FirstName string
    For human users, their first name.
    LastName string
    For human users, their last name.
    Name string
    For machine users, the name of the user.
    TerminationProtection bool
    If set to true, this User cannot be deleted.
    type String
    Either 'human' or 'machine'.
    appType String
    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.
    email String
    For human users, their email.
    expireAt Integer
    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.
    firstName String
    For human users, their first name.
    lastName String
    For human users, their last name.
    name String
    For machine users, the name of the user.
    terminationProtection Boolean
    If set to true, this User cannot be deleted.
    type string
    Either 'human' or 'machine'.
    appType string
    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.
    email string
    For human users, their email.
    expireAt number
    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.
    firstName string
    For human users, their first name.
    lastName string
    For human users, their last name.
    name string
    For machine users, the name of the user.
    terminationProtection boolean
    If set to true, this User cannot be deleted.
    type str
    Either 'human' or 'machine'.
    app_type str
    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.
    email str
    For human users, their email.
    expire_at int
    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.
    first_name str
    For human users, their first name.
    last_name str
    For human users, their last name.
    name str
    For machine users, the name of the user.
    termination_protection bool
    If set to true, this User cannot be deleted.
    type String
    Either 'human' or 'machine'.
    appType String
    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.
    email String
    For human users, their email.
    expireAt Number
    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.
    firstName String
    For human users, their first name.
    lastName String
    For human users, their last name.
    name String
    For machine users, the name of the user.
    terminationProtection Boolean
    If set to true, this User cannot be deleted.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

    DbUsername string
    The username that the user will use to access the sidecar.
    Id string
    The provider-assigned unique ID for this managed resource.
    MachineUserAccessToken string
    If the user is of type machine, this is the access token (database password) of this user.
    DbUsername string
    The username that the user will use to access the sidecar.
    Id string
    The provider-assigned unique ID for this managed resource.
    MachineUserAccessToken string
    If the user is of type machine, this is the access token (database password) of this user.
    dbUsername String
    The username that the user will use to access the sidecar.
    id String
    The provider-assigned unique ID for this managed resource.
    machineUserAccessToken String
    If the user is of type machine, this is the access token (database password) of this user.
    dbUsername string
    The username that the user will use to access the sidecar.
    id string
    The provider-assigned unique ID for this managed resource.
    machineUserAccessToken string
    If the user is of type machine, this is the access token (database password) of this user.
    db_username str
    The username that the user will use to access the sidecar.
    id str
    The provider-assigned unique ID for this managed resource.
    machine_user_access_token str
    If the user is of type machine, this is the access token (database password) of this user.
    dbUsername String
    The username that the user will use to access the sidecar.
    id String
    The provider-assigned unique ID for this managed resource.
    machineUserAccessToken String
    If the user is of type machine, this is the access token (database password) of this user.

    Look up Existing User Resource

    Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_type: Optional[str] = None,
        db_username: Optional[str] = None,
        email: Optional[str] = None,
        expire_at: Optional[int] = None,
        first_name: Optional[str] = None,
        last_name: Optional[str] = None,
        machine_user_access_token: Optional[str] = None,
        name: Optional[str] = None,
        termination_protection: Optional[bool] = None,
        type: Optional[str] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    resources:  _:    type: formal:User    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AppType string
    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.
    DbUsername string
    The username that the user will use to access the sidecar.
    Email string
    For human users, their email.
    ExpireAt int
    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.
    FirstName string
    For human users, their first name.
    LastName string
    For human users, their last name.
    MachineUserAccessToken string
    If the user is of type machine, this is the access token (database password) of this user.
    Name string
    For machine users, the name of the user.
    TerminationProtection bool
    If set to true, this User cannot be deleted.
    Type string
    Either 'human' or 'machine'.
    AppType string
    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.
    DbUsername string
    The username that the user will use to access the sidecar.
    Email string
    For human users, their email.
    ExpireAt int
    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.
    FirstName string
    For human users, their first name.
    LastName string
    For human users, their last name.
    MachineUserAccessToken string
    If the user is of type machine, this is the access token (database password) of this user.
    Name string
    For machine users, the name of the user.
    TerminationProtection bool
    If set to true, this User cannot be deleted.
    Type string
    Either 'human' or 'machine'.
    appType String
    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.
    dbUsername String
    The username that the user will use to access the sidecar.
    email String
    For human users, their email.
    expireAt Integer
    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.
    firstName String
    For human users, their first name.
    lastName String
    For human users, their last name.
    machineUserAccessToken String
    If the user is of type machine, this is the access token (database password) of this user.
    name String
    For machine users, the name of the user.
    terminationProtection Boolean
    If set to true, this User cannot be deleted.
    type String
    Either 'human' or 'machine'.
    appType string
    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.
    dbUsername string
    The username that the user will use to access the sidecar.
    email string
    For human users, their email.
    expireAt number
    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.
    firstName string
    For human users, their first name.
    lastName string
    For human users, their last name.
    machineUserAccessToken string
    If the user is of type machine, this is the access token (database password) of this user.
    name string
    For machine users, the name of the user.
    terminationProtection boolean
    If set to true, this User cannot be deleted.
    type string
    Either 'human' or 'machine'.
    app_type str
    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.
    db_username str
    The username that the user will use to access the sidecar.
    email str
    For human users, their email.
    expire_at int
    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.
    first_name str
    For human users, their first name.
    last_name str
    For human users, their last name.
    machine_user_access_token str
    If the user is of type machine, this is the access token (database password) of this user.
    name str
    For machine users, the name of the user.
    termination_protection bool
    If set to true, this User cannot be deleted.
    type str
    Either 'human' or 'machine'.
    appType String
    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.
    dbUsername String
    The username that the user will use to access the sidecar.
    email String
    For human users, their email.
    expireAt Number
    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.
    firstName String
    For human users, their first name.
    lastName String
    For human users, their last name.
    machineUserAccessToken String
    If the user is of type machine, this is the access token (database password) of this user.
    name String
    For machine users, the name of the user.
    terminationProtection Boolean
    If set to true, this User cannot be deleted.
    type String
    Either 'human' or 'machine'.

    Package Details

    Repository
    formal formalco/pulumi-formal
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the formal Terraform Provider.
    formal logo
    Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal
    formalco/pulumi-formal