Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. iam
  5. User
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.iam.User

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage iam user

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@volcengine/pulumi";

const foo = new volcengine.iam.User("foo", {
    description: "test",
    displayName: "name",
    userName: "tf-test",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.iam.User("foo",
    description="test",
    display_name="name",
    user_name="tf-test")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/iam"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iam.NewUser(ctx, "foo", &iam.UserArgs{
			Description: pulumi.String("test"),
			DisplayName: pulumi.String("name"),
			UserName:    pulumi.String("tf-test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Iam.User("foo", new()
    {
        Description = "test",
        DisplayName = "name",
        UserName = "tf-test",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.iam.User;
import com.pulumi.volcengine.iam.UserArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var foo = new User("foo", UserArgs.builder()        
            .description("test")
            .displayName("name")
            .userName("tf-test")
            .build());

    }
}

    resources:
  foo:
    type: volcengine:iam:User
    properties:
      description: test
      displayName: name
      userName: tf-test

    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,
         user_name: Optional[str] = None,
         description: Optional[str] = None,
         display_name: Optional[str] = None,
         email: Optional[str] = None,
         mobile_phone: Optional[str] = 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: volcengine:iam: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 volcengineUserResource = new Volcengine.Iam.User("volcengineUserResource", new()
{
    UserName = "string",
    Description = "string",
    DisplayName = "string",
    Email = "string",
    MobilePhone = "string",
});

    example, err := iam.NewUser(ctx, "volcengineUserResource", &iam.UserArgs{
	UserName:    pulumi.String("string"),
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Email:       pulumi.String("string"),
	MobilePhone: pulumi.String("string"),
})

    var volcengineUserResource = new User("volcengineUserResource", UserArgs.builder()
    .userName("string")
    .description("string")
    .displayName("string")
    .email("string")
    .mobilePhone("string")
    .build());

    volcengine_user_resource = volcengine.iam.User("volcengineUserResource",
    user_name="string",
    description="string",
    display_name="string",
    email="string",
    mobile_phone="string")

    const volcengineUserResource = new volcengine.iam.User("volcengineUserResource", {
    userName: "string",
    description: "string",
    displayName: "string",
    email: "string",
    mobilePhone: "string",
});

    type: volcengine:iam:User
properties:
    description: string
    displayName: string
    email: string
    mobilePhone: string
    userName: 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:

    UserName string
    The name of the user.
    Description string
    The description of the user.
    DisplayName string
    The display name of the user.
    Email string
    The email of the user.
    MobilePhone string
    The mobile phone of the user.
    UserName string
    The name of the user.
    Description string
    The description of the user.
    DisplayName string
    The display name of the user.
    Email string
    The email of the user.
    MobilePhone string
    The mobile phone of the user.
    userName String
    The name of the user.
    description String
    The description of the user.
    displayName String
    The display name of the user.
    email String
    The email of the user.
    mobilePhone String
    The mobile phone of the user.
    userName string
    The name of the user.
    description string
    The description of the user.
    displayName string
    The display name of the user.
    email string
    The email of the user.
    mobilePhone string
    The mobile phone of the user.
    user_name str
    The name of the user.
    description str
    The description of the user.
    display_name str
    The display name of the user.
    email str
    The email of the user.
    mobile_phone str
    The mobile phone of the user.
    userName String
    The name of the user.
    description String
    The description of the user.
    displayName String
    The display name of the user.
    email String
    The email of the user.
    mobilePhone String
    The mobile phone of the user.

    Outputs

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

    AccountId string
    Main account ID to which the sub-user belongs.
    CreateDate string
    The create date of the user.
    EmailIsVerify bool
    Whether the email has been verified.
    Id string
    The provider-assigned unique ID for this managed resource.
    MobilePhoneIsVerify bool
    Whether the phone number has been verified.
    Trn string
    The trn of the user.
    UpdateDate string
    The update date of the user.
    UserId string
    The id of the user.
    AccountId string
    Main account ID to which the sub-user belongs.
    CreateDate string
    The create date of the user.
    EmailIsVerify bool
    Whether the email has been verified.
    Id string
    The provider-assigned unique ID for this managed resource.
    MobilePhoneIsVerify bool
    Whether the phone number has been verified.
    Trn string
    The trn of the user.
    UpdateDate string
    The update date of the user.
    UserId string
    The id of the user.
    accountId String
    Main account ID to which the sub-user belongs.
    createDate String
    The create date of the user.
    emailIsVerify Boolean
    Whether the email has been verified.
    id String
    The provider-assigned unique ID for this managed resource.
    mobilePhoneIsVerify Boolean
    Whether the phone number has been verified.
    trn String
    The trn of the user.
    updateDate String
    The update date of the user.
    userId String
    The id of the user.
    accountId string
    Main account ID to which the sub-user belongs.
    createDate string
    The create date of the user.
    emailIsVerify boolean
    Whether the email has been verified.
    id string
    The provider-assigned unique ID for this managed resource.
    mobilePhoneIsVerify boolean
    Whether the phone number has been verified.
    trn string
    The trn of the user.
    updateDate string
    The update date of the user.
    userId string
    The id of the user.
    account_id str
    Main account ID to which the sub-user belongs.
    create_date str
    The create date of the user.
    email_is_verify bool
    Whether the email has been verified.
    id str
    The provider-assigned unique ID for this managed resource.
    mobile_phone_is_verify bool
    Whether the phone number has been verified.
    trn str
    The trn of the user.
    update_date str
    The update date of the user.
    user_id str
    The id of the user.
    accountId String
    Main account ID to which the sub-user belongs.
    createDate String
    The create date of the user.
    emailIsVerify Boolean
    Whether the email has been verified.
    id String
    The provider-assigned unique ID for this managed resource.
    mobilePhoneIsVerify Boolean
    Whether the phone number has been verified.
    trn String
    The trn of the user.
    updateDate String
    The update date of the user.
    userId String
    The id of the 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,
        account_id: Optional[str] = None,
        create_date: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        email: Optional[str] = None,
        email_is_verify: Optional[bool] = None,
        mobile_phone: Optional[str] = None,
        mobile_phone_is_verify: Optional[bool] = None,
        trn: Optional[str] = None,
        update_date: Optional[str] = None,
        user_id: Optional[str] = None,
        user_name: 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: volcengine:iam: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:
    AccountId string
    Main account ID to which the sub-user belongs.
    CreateDate string
    The create date of the user.
    Description string
    The description of the user.
    DisplayName string
    The display name of the user.
    Email string
    The email of the user.
    EmailIsVerify bool
    Whether the email has been verified.
    MobilePhone string
    The mobile phone of the user.
    MobilePhoneIsVerify bool
    Whether the phone number has been verified.
    Trn string
    The trn of the user.
    UpdateDate string
    The update date of the user.
    UserId string
    The id of the user.
    UserName string
    The name of the user.
    AccountId string
    Main account ID to which the sub-user belongs.
    CreateDate string
    The create date of the user.
    Description string
    The description of the user.
    DisplayName string
    The display name of the user.
    Email string
    The email of the user.
    EmailIsVerify bool
    Whether the email has been verified.
    MobilePhone string
    The mobile phone of the user.
    MobilePhoneIsVerify bool
    Whether the phone number has been verified.
    Trn string
    The trn of the user.
    UpdateDate string
    The update date of the user.
    UserId string
    The id of the user.
    UserName string
    The name of the user.
    accountId String
    Main account ID to which the sub-user belongs.
    createDate String
    The create date of the user.
    description String
    The description of the user.
    displayName String
    The display name of the user.
    email String
    The email of the user.
    emailIsVerify Boolean
    Whether the email has been verified.
    mobilePhone String
    The mobile phone of the user.
    mobilePhoneIsVerify Boolean
    Whether the phone number has been verified.
    trn String
    The trn of the user.
    updateDate String
    The update date of the user.
    userId String
    The id of the user.
    userName String
    The name of the user.
    accountId string
    Main account ID to which the sub-user belongs.
    createDate string
    The create date of the user.
    description string
    The description of the user.
    displayName string
    The display name of the user.
    email string
    The email of the user.
    emailIsVerify boolean
    Whether the email has been verified.
    mobilePhone string
    The mobile phone of the user.
    mobilePhoneIsVerify boolean
    Whether the phone number has been verified.
    trn string
    The trn of the user.
    updateDate string
    The update date of the user.
    userId string
    The id of the user.
    userName string
    The name of the user.
    account_id str
    Main account ID to which the sub-user belongs.
    create_date str
    The create date of the user.
    description str
    The description of the user.
    display_name str
    The display name of the user.
    email str
    The email of the user.
    email_is_verify bool
    Whether the email has been verified.
    mobile_phone str
    The mobile phone of the user.
    mobile_phone_is_verify bool
    Whether the phone number has been verified.
    trn str
    The trn of the user.
    update_date str
    The update date of the user.
    user_id str
    The id of the user.
    user_name str
    The name of the user.
    accountId String
    Main account ID to which the sub-user belongs.
    createDate String
    The create date of the user.
    description String
    The description of the user.
    displayName String
    The display name of the user.
    email String
    The email of the user.
    emailIsVerify Boolean
    Whether the email has been verified.
    mobilePhone String
    The mobile phone of the user.
    mobilePhoneIsVerify Boolean
    Whether the phone number has been verified.
    trn String
    The trn of the user.
    updateDate String
    The update date of the user.
    userId String
    The id of the user.
    userName String
    The name of the user.

    Import

    Iam user can be imported using the UserName, e.g.

    $ pulumi import volcengine:iam/user:User default user_name

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
    volcengine/pulumi-volcengine