@pulumiverse/harbor
Version:
A Pulumi package for creating and managing Harbor resources.
118 lines (117 loc) • 3.57 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ## Import
*
* ```sh
* $ pulumi import harbor:index/user:User main /users/19
* ```
*/
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;
/**
* If the user will have admin rights within Harbor (Default: `false`)
*/
readonly admin: pulumi.Output<boolean | undefined>;
/**
* Any comments for that are need for the internal user.
*/
readonly comment: pulumi.Output<string | undefined>;
/**
* The email address of the internal user.
*/
readonly email: pulumi.Output<string>;
/**
* The Full Name of the internal user.
*/
readonly fullName: pulumi.Output<string>;
/**
* The password for the internal user.
*/
readonly password: pulumi.Output<string>;
/**
* The username of the internal 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 {
/**
* If the user will have admin rights within Harbor (Default: `false`)
*/
admin?: pulumi.Input<boolean>;
/**
* Any comments for that are need for the internal user.
*/
comment?: pulumi.Input<string>;
/**
* The email address of the internal user.
*/
email?: pulumi.Input<string>;
/**
* The Full Name of the internal user.
*/
fullName?: pulumi.Input<string>;
/**
* The password for the internal user.
*/
password?: pulumi.Input<string>;
/**
* The username of the internal user.
*/
username?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a User resource.
*/
export interface UserArgs {
/**
* If the user will have admin rights within Harbor (Default: `false`)
*/
admin?: pulumi.Input<boolean>;
/**
* Any comments for that are need for the internal user.
*/
comment?: pulumi.Input<string>;
/**
* The email address of the internal user.
*/
email: pulumi.Input<string>;
/**
* The Full Name of the internal user.
*/
fullName: pulumi.Input<string>;
/**
* The password for the internal user.
*/
password: pulumi.Input<string>;
/**
* The username of the internal user.
*/
username: pulumi.Input<string>;
}