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

volcengine.cloud_identity.User

Explore with Pulumi AI

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

Provides a resource to manage cloud identity user

Example Usage

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

const foo = new volcengine.cloud_identity.User("foo", {
    description: "tf",
    displayName: "tf-test-user",
    email: "88@qq.com",
    phone: "1810000****",
    userName: "acc-test-user",
});
Copy
import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.cloud_identity.User("foo",
    description="tf",
    display_name="tf-test-user",
    email="88@qq.com",
    phone="1810000****",
    user_name="acc-test-user")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloud_identity.NewUser(ctx, "foo", &cloud_identity.UserArgs{
			Description: pulumi.String("tf"),
			DisplayName: pulumi.String("tf-test-user"),
			Email:       pulumi.String("88@qq.com"),
			Phone:       pulumi.String("1810000****"),
			UserName:    pulumi.String("acc-test-user"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Cloud_identity.User("foo", new()
    {
        Description = "tf",
        DisplayName = "tf-test-user",
        Email = "88@qq.com",
        Phone = "1810000****",
        UserName = "acc-test-user",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.cloud_identity.User;
import com.pulumi.volcengine.cloud_identity.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("tf")
            .displayName("tf-test-user")
            .email("88@qq.com")
            .phone("1810000****")
            .userName("acc-test-user")
            .build());

    }
}
Copy
resources:
  foo:
    type: volcengine:cloud_identity:User
    properties:
      description: tf
      displayName: tf-test-user
      email: 88@qq.com
      phone: 1810000****
      userName: acc-test-user
Copy

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,
         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:cloud_identity:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 Volcengine.Cloud_identity.User("userResource", new()
{
    UserName = "string",
    Description = "string",
    DisplayName = "string",
    Email = "string",
    Phone = "string",
});
Copy
example, err := cloud_identity.NewUser(ctx, "userResource", &cloud_identity.UserArgs{
	UserName:    pulumi.String("string"),
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Email:       pulumi.String("string"),
	Phone:       pulumi.String("string"),
})
Copy
var userResource = new User("userResource", UserArgs.builder()
    .userName("string")
    .description("string")
    .displayName("string")
    .email("string")
    .phone("string")
    .build());
Copy
user_resource = volcengine.cloud_identity.User("userResource",
    user_name="string",
    description="string",
    display_name="string",
    email="string",
    phone="string")
Copy
const userResource = new volcengine.cloud_identity.User("userResource", {
    userName: "string",
    description: "string",
    displayName: "string",
    email: "string",
    phone: "string",
});
Copy
type: volcengine:cloud_identity:User
properties:
    description: string
    displayName: string
    email: string
    phone: string
    userName: string
Copy

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 This property is required. string
The name of the cloud identity user.
Description string
The description of the cloud identity user.
DisplayName string
The display name of the cloud identity user.
Email string
The email of the cloud identity user.
Phone string
The phone of the cloud identity user. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
UserName This property is required. string
The name of the cloud identity user.
Description string
The description of the cloud identity user.
DisplayName string
The display name of the cloud identity user.
Email string
The email of the cloud identity user.
Phone string
The phone of the cloud identity user. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
userName This property is required. String
The name of the cloud identity user.
description String
The description of the cloud identity user.
displayName String
The display name of the cloud identity user.
email String
The email of the cloud identity user.
phone String
The phone of the cloud identity user. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
userName This property is required. string
The name of the cloud identity user.
description string
The description of the cloud identity user.
displayName string
The display name of the cloud identity user.
email string
The email of the cloud identity user.
phone string
The phone of the cloud identity user. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
user_name This property is required. str
The name of the cloud identity user.
description str
The description of the cloud identity user.
display_name str
The display name of the cloud identity user.
email str
The email of the cloud identity user.
phone str
The phone of the cloud identity user. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
userName This property is required. String
The name of the cloud identity user.
description String
The description of the cloud identity user.
displayName String
The display name of the cloud identity user.
email String
The email of the cloud identity user.
phone String
The phone of the cloud identity user. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
IdentityType string
The identity type of the cloud identity user.
Source string
The source of the cloud identity user.
Id string
The provider-assigned unique ID for this managed resource.
IdentityType string
The identity type of the cloud identity user.
Source string
The source of the cloud identity user.
id String
The provider-assigned unique ID for this managed resource.
identityType String
The identity type of the cloud identity user.
source String
The source of the cloud identity user.
id string
The provider-assigned unique ID for this managed resource.
identityType string
The identity type of the cloud identity user.
source string
The source of the cloud identity user.
id str
The provider-assigned unique ID for this managed resource.
identity_type str
The identity type of the cloud identity user.
source str
The source of the cloud identity user.
id String
The provider-assigned unique ID for this managed resource.
identityType String
The identity type of the cloud identity user.
source String
The source of the cloud identity 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,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        email: Optional[str] = None,
        identity_type: Optional[str] = None,
        phone: Optional[str] = None,
        source: 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:cloud_identity:User    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
The description of the cloud identity user.
DisplayName string
The display name of the cloud identity user.
Email string
The email of the cloud identity user.
IdentityType string
The identity type of the cloud identity user.
Phone string
The phone of the cloud identity user. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
Source string
The source of the cloud identity user.
UserName string
The name of the cloud identity user.
Description string
The description of the cloud identity user.
DisplayName string
The display name of the cloud identity user.
Email string
The email of the cloud identity user.
IdentityType string
The identity type of the cloud identity user.
Phone string
The phone of the cloud identity user. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
Source string
The source of the cloud identity user.
UserName string
The name of the cloud identity user.
description String
The description of the cloud identity user.
displayName String
The display name of the cloud identity user.
email String
The email of the cloud identity user.
identityType String
The identity type of the cloud identity user.
phone String
The phone of the cloud identity user. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
source String
The source of the cloud identity user.
userName String
The name of the cloud identity user.
description string
The description of the cloud identity user.
displayName string
The display name of the cloud identity user.
email string
The email of the cloud identity user.
identityType string
The identity type of the cloud identity user.
phone string
The phone of the cloud identity user. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
source string
The source of the cloud identity user.
userName string
The name of the cloud identity user.
description str
The description of the cloud identity user.
display_name str
The display name of the cloud identity user.
email str
The email of the cloud identity user.
identity_type str
The identity type of the cloud identity user.
phone str
The phone of the cloud identity user. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
source str
The source of the cloud identity user.
user_name str
The name of the cloud identity user.
description String
The description of the cloud identity user.
displayName String
The display name of the cloud identity user.
email String
The email of the cloud identity user.
identityType String
The identity type of the cloud identity user.
phone String
The phone of the cloud identity user. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
source String
The source of the cloud identity user.
userName String
The name of the cloud identity user.

Import

CloudIdentityUser can be imported using the id, e.g.

$ pulumi import volcengine:cloud_identity/user:User default resource_id
Copy

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 v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine