@lbrlabs/pulumi-cockroach
Version:
A Pulumi package to create and managed cockroach db resources in Pulumi programs.
72 lines (71 loc) • 2.33 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* CockroachDB database.
*/
export declare class Database extends pulumi.CustomResource {
/**
* Get an existing Database 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?: DatabaseState, opts?: pulumi.CustomResourceOptions): Database;
/**
* Returns true if the given object is an instance of Database. 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 Database;
/**
* ID of the cluster the database belongs to.
*/
readonly clusterId: pulumi.Output<string>;
/**
* Database name.
*/
readonly name: pulumi.Output<string>;
/**
* Number of tables in the database.
*/
readonly tableCount: pulumi.Output<number>;
/**
* Create a Database 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: DatabaseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Database resources.
*/
export interface DatabaseState {
/**
* ID of the cluster the database belongs to.
*/
clusterId?: pulumi.Input<string>;
/**
* Database name.
*/
name?: pulumi.Input<string>;
/**
* Number of tables in the database.
*/
tableCount?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Database resource.
*/
export interface DatabaseArgs {
/**
* ID of the cluster the database belongs to.
*/
clusterId: pulumi.Input<string>;
/**
* Database name.
*/
name: pulumi.Input<string>;
}