@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
176 lines (175 loc) • 4.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage iam user
* ## Example Usage
*
* ```typescript
* 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
*
* Iam user can be imported using the UserName, e.g.
*
* ```sh
* $ pulumi import volcengine:iam/user:User default user_name
* ```
*/
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;
/**
* Main account ID to which the sub-user belongs.
*/
readonly accountId: pulumi.Output<string>;
/**
* The create date of the user.
*/
readonly createDate: pulumi.Output<string>;
/**
* The description of the user.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The display name of the user.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* The email of the user.
*/
readonly email: pulumi.Output<string | undefined>;
/**
* Whether the email has been verified.
*/
readonly emailIsVerify: pulumi.Output<boolean>;
/**
* The mobile phone of the user.
*/
readonly mobilePhone: pulumi.Output<string | undefined>;
/**
* Whether the phone number has been verified.
*/
readonly mobilePhoneIsVerify: pulumi.Output<boolean>;
/**
* The trn of the user.
*/
readonly trn: pulumi.Output<string>;
/**
* The update date of the user.
*/
readonly updateDate: pulumi.Output<string>;
/**
* The id of the user.
*/
readonly userId: pulumi.Output<string>;
/**
* The name of the 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 {
/**
* Main account ID to which the sub-user belongs.
*/
accountId?: pulumi.Input<string>;
/**
* The create date of the user.
*/
createDate?: pulumi.Input<string>;
/**
* The description of the user.
*/
description?: pulumi.Input<string>;
/**
* The display name of the user.
*/
displayName?: pulumi.Input<string>;
/**
* The email of the user.
*/
email?: pulumi.Input<string>;
/**
* Whether the email has been verified.
*/
emailIsVerify?: pulumi.Input<boolean>;
/**
* The mobile phone of the user.
*/
mobilePhone?: pulumi.Input<string>;
/**
* Whether the phone number has been verified.
*/
mobilePhoneIsVerify?: pulumi.Input<boolean>;
/**
* The trn of the user.
*/
trn?: pulumi.Input<string>;
/**
* The update date of the user.
*/
updateDate?: pulumi.Input<string>;
/**
* The id of the user.
*/
userId?: pulumi.Input<string>;
/**
* The name of the user.
*/
userName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a User resource.
*/
export interface UserArgs {
/**
* The description of the user.
*/
description?: pulumi.Input<string>;
/**
* The display name of the user.
*/
displayName?: pulumi.Input<string>;
/**
* The email of the user.
*/
email?: pulumi.Input<string>;
/**
* The mobile phone of the user.
*/
mobilePhone?: pulumi.Input<string>;
/**
* The name of the user.
*/
userName: pulumi.Input<string>;
}