@pulumiverse/scaleway/datawarehouse/user.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Creates and manages Scaleway Data Warehouse users within a deployment.
 * For more information refer to the [product documentation](https://www.scaleway.com/en/docs/data-warehouse/).
 *
 * ## Example Usage
 *
 * ### Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * const main = new scaleway.datawarehouse.Deployment("main", {
 *     name: "my-datawarehouse",
 *     version: "v25",
 *     replicaCount: 1,
 *     cpuMin: 2,
 *     cpuMax: 4,
 *     ramPerCpu: 4,
 *     password: "thiZ_is_v&ry_s3cret",
 * });
 * const mainUser = new scaleway.datawarehouse.User("main", {
 *     deploymentId: main.id,
 *     name: "my_user",
 *     password: "user_password_123",
 * });
 * ```
 *
 * ### Admin User
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * const main = new scaleway.datawarehouse.Deployment("main", {
 *     name: "my-datawarehouse",
 *     version: "v25",
 *     replicaCount: 1,
 *     cpuMin: 2,
 *     cpuMax: 4,
 *     ramPerCpu: 4,
 *     password: "thiZ_is_v&ry_s3cret",
 * });
 * const admin = new scaleway.datawarehouse.User("admin", {
 *     deploymentId: main.id,
 *     name: "admin_user",
 *     password: "admin_password_456",
 *     isAdmin: true,
 * });
 * ```
 *
 * ## Import
 *
 * Data Warehouse users can be imported using the `{region}/{deployment_id}/{name}`, e.g.
 *
 * ```sh
 * $ pulumi import scaleway:datawarehouse/user:User main fr-par/11111111-1111-1111-1111-111111111111/my_user
 * ```
 */
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;
    /**
     * ID of the Data Warehouse deployment to which this user belongs.
     */
    readonly deploymentId: pulumi.Output<string>;
    /**
     * Whether the user has administrator privileges. Defaults to `false`.
     */
    readonly isAdmin: pulumi.Output<boolean | undefined>;
    /**
     * Name of the ClickHouse user.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Password for the ClickHouse user.
     */
    readonly password: pulumi.Output<string>;
    /**
     * `region`) The region in which the user should be created.
     */
    readonly region: pulumi.Output<string | undefined>;
    /**
     * 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 {
    /**
     * ID of the Data Warehouse deployment to which this user belongs.
     */
    deploymentId?: pulumi.Input<string | undefined>;
    /**
     * Whether the user has administrator privileges. Defaults to `false`.
     */
    isAdmin?: pulumi.Input<boolean | undefined>;
    /**
     * Name of the ClickHouse user.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Password for the ClickHouse user.
     */
    password?: pulumi.Input<string | undefined>;
    /**
     * `region`) The region in which the user should be created.
     */
    region?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a User resource.
 */
export interface UserArgs {
    /**
     * ID of the Data Warehouse deployment to which this user belongs.
     */
    deploymentId: pulumi.Input<string>;
    /**
     * Whether the user has administrator privileges. Defaults to `false`.
     */
    isAdmin?: pulumi.Input<boolean | undefined>;
    /**
     * Name of the ClickHouse user.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Password for the ClickHouse user.
     */
    password: pulumi.Input<string>;
    /**
     * `region`) The region in which the user should be created.
     */
    region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=user.d.ts.map