@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
138 lines (137 loc) • 4.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage cloud identity user
* ## Example Usage
*
* ```typescript
* 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",
* });
* ```
*
* ## Import
*
* CloudIdentityUser can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:cloud_identity/user:User default resource_id
* ```
*/
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 description of the cloud identity user.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The display name of the cloud identity user.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* The email of the cloud identity user.
*/
readonly email: pulumi.Output<string | undefined>;
/**
* The identity type of the cloud identity user.
*/
readonly identityType: pulumi.Output<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 ignoreChanges ignore changes in fields.
*/
readonly phone: pulumi.Output<string | undefined>;
/**
* The source of the cloud identity user.
*/
readonly source: pulumi.Output<string>;
/**
* The name of the cloud identity user.
*/
readonly userName: 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 {
/**
* The description of the cloud identity user.
*/
description?: pulumi.Input<string>;
/**
* The display name of the cloud identity user.
*/
displayName?: pulumi.Input<string>;
/**
* The email of the cloud identity user.
*/
email?: pulumi.Input<string>;
/**
* The identity type of the cloud identity user.
*/
identityType?: pulumi.Input<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 ignoreChanges ignore changes in fields.
*/
phone?: pulumi.Input<string>;
/**
* The source of the cloud identity user.
*/
source?: pulumi.Input<string>;
/**
* The name of the cloud identity user.
*/
userName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a User resource.
*/
export interface UserArgs {
/**
* The description of the cloud identity user.
*/
description?: pulumi.Input<string>;
/**
* The display name of the cloud identity user.
*/
displayName?: pulumi.Input<string>;
/**
* The email of the cloud identity user.
*/
email?: pulumi.Input<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 ignoreChanges ignore changes in fields.
*/
phone?: pulumi.Input<string>;
/**
* The name of the cloud identity user.
*/
userName: pulumi.Input<string>;
}