UNPKG

@lbrlabs/pulumi-cockroach

Version:

A Pulumi package to create and managed cockroach db resources in Pulumi programs.

70 lines (69 loc) 2.78 kB
import * as pulumi from "@pulumi/pulumi"; /** * CockroachDB SQL user. */ export declare class SqlUser extends pulumi.CustomResource { /** * Get an existing SqlUser 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?: SqlUserState, opts?: pulumi.CustomResourceOptions): SqlUser; /** * Returns true if the given object is an instance of SqlUser. 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 SqlUser; readonly clusterId: pulumi.Output<string>; /** * SQL user name. */ readonly name: pulumi.Output<string>; /** * If provided, this field sets the password of the SQL user when created. If omitted, a random password is generated, but * not saved to Terraform state. The password must be changed via the CockroachDB cloud console. */ readonly password: pulumi.Output<string | undefined>; /** * Create a SqlUser 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: SqlUserArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering SqlUser resources. */ export interface SqlUserState { clusterId?: pulumi.Input<string>; /** * SQL user name. */ name?: pulumi.Input<string>; /** * If provided, this field sets the password of the SQL user when created. If omitted, a random password is generated, but * not saved to Terraform state. The password must be changed via the CockroachDB cloud console. */ password?: pulumi.Input<string>; } /** * The set of arguments for constructing a SqlUser resource. */ export interface SqlUserArgs { clusterId: pulumi.Input<string>; /** * SQL user name. */ name: pulumi.Input<string>; /** * If provided, this field sets the password of the SQL user when created. If omitted, a random password is generated, but * not saved to Terraform state. The password must be changed via the CockroachDB cloud console. */ password?: pulumi.Input<string>; }