@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
168 lines (167 loc) • 6.13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Database Instances are managed Postgres instances, composed of a primary Postgres compute instance and 0 or more read replica instances.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const _this = new databricks.DatabaseInstance("this", {
* name: "my-database-instance",
* capacity: "CU_2",
* });
* ```
*
* ## Import
*
* As of Pulumi v1.5, resources can be imported through configuration.
*
* hcl
*
* import {
*
* id = name
*
* to = databricks_database_instance.this
*
* }
*
* If you are using an older version of Pulumi, import the resource using the `pulumi import` command as follows:
*
* ```sh
* $ pulumi import databricks:index/databaseInstance:DatabaseInstance databricks_database_instance name
* ```
*/
export declare class DatabaseInstance extends pulumi.CustomResource {
/**
* Get an existing DatabaseInstance 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?: DatabaseInstanceState, opts?: pulumi.CustomResourceOptions): DatabaseInstance;
/**
* Returns true if the given object is an instance of DatabaseInstance. 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 DatabaseInstance;
/**
* The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
*/
readonly capacity: pulumi.Output<string | undefined>;
/**
* (string) - The timestamp when the instance was created
*/
readonly creationTime: pulumi.Output<string>;
/**
* (string) - The email of the creator of the instance
*/
readonly creator: pulumi.Output<string>;
/**
* (boolean) - xref AIP-129. `stopped` is owned by the client, while `effectiveStopped` is owned by the server.
* `stopped` will only be set in Create/Update response messages if and only if the user provides the field via the request.
* `effectiveStopped` on the other hand will always bet set in all response messages (Create/Update/Get/List)
*/
readonly effectiveStopped: pulumi.Output<boolean>;
/**
* The name of the instance. This is the unique identifier for the instance
*/
readonly name: pulumi.Output<string>;
/**
* (string) - The version of Postgres running on the instance
*/
readonly pgVersion: pulumi.Output<string>;
/**
* (string) - The DNS endpoint to connect to the instance for read+write access
*/
readonly readWriteDns: pulumi.Output<string>;
/**
* (string) - The current state of the instance. Possible values are: `AVAILABLE`, `DELETING`, `FAILING_OVER`, `STARTING`, `STOPPED`, `UPDATING`
*/
readonly state: pulumi.Output<string>;
/**
* Whether the instance is stopped
*/
readonly stopped: pulumi.Output<boolean | undefined>;
/**
* (string) - An immutable UUID identifier for the instance
*/
readonly uid: pulumi.Output<string>;
/**
* Create a DatabaseInstance 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?: DatabaseInstanceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DatabaseInstance resources.
*/
export interface DatabaseInstanceState {
/**
* The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
*/
capacity?: pulumi.Input<string>;
/**
* (string) - The timestamp when the instance was created
*/
creationTime?: pulumi.Input<string>;
/**
* (string) - The email of the creator of the instance
*/
creator?: pulumi.Input<string>;
/**
* (boolean) - xref AIP-129. `stopped` is owned by the client, while `effectiveStopped` is owned by the server.
* `stopped` will only be set in Create/Update response messages if and only if the user provides the field via the request.
* `effectiveStopped` on the other hand will always bet set in all response messages (Create/Update/Get/List)
*/
effectiveStopped?: pulumi.Input<boolean>;
/**
* The name of the instance. This is the unique identifier for the instance
*/
name?: pulumi.Input<string>;
/**
* (string) - The version of Postgres running on the instance
*/
pgVersion?: pulumi.Input<string>;
/**
* (string) - The DNS endpoint to connect to the instance for read+write access
*/
readWriteDns?: pulumi.Input<string>;
/**
* (string) - The current state of the instance. Possible values are: `AVAILABLE`, `DELETING`, `FAILING_OVER`, `STARTING`, `STOPPED`, `UPDATING`
*/
state?: pulumi.Input<string>;
/**
* Whether the instance is stopped
*/
stopped?: pulumi.Input<boolean>;
/**
* (string) - An immutable UUID identifier for the instance
*/
uid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DatabaseInstance resource.
*/
export interface DatabaseInstanceArgs {
/**
* The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
*/
capacity?: pulumi.Input<string>;
/**
* The name of the instance. This is the unique identifier for the instance
*/
name?: pulumi.Input<string>;
/**
* Whether the instance is stopped
*/
stopped?: pulumi.Input<boolean>;
}