@pulumi/databricks/getDatabaseInstance.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * This data source can be used to get a single Database Instance.
 *
 * ## Example Usage
 *
 * Referring to a Database Instance by name:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const _this = databricks.getDatabaseInstance({
 *     name: "my-database-instance",
 * });
 * ```
 */
export declare function getDatabaseInstance(args: GetDatabaseInstanceArgs, opts?: pulumi.InvokeOptions): Promise<GetDatabaseInstanceResult>;
/**
 * A collection of arguments for invoking getDatabaseInstance.
 */
export interface GetDatabaseInstanceArgs {
    /**
     * (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
     */
    capacity?: string;
    /**
     * The name of the instance. This is the unique identifier for the instance
     */
    name: string;
    /**
     * (boolean) - Whether the instance is stopped
     */
    stopped?: boolean;
}
/**
 * A collection of values returned by getDatabaseInstance.
 */
export interface GetDatabaseInstanceResult {
    /**
     * (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
     */
    readonly capacity?: string;
    /**
     * (string) - The timestamp when the instance was created
     */
    readonly creationTime: string;
    /**
     * (string) - The email of the creator of the instance
     */
    readonly creator: 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: boolean;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * (string) - The name of the instance. This is the unique identifier for the instance
     */
    readonly name: string;
    /**
     * (string) - The version of Postgres running on the instance
     */
    readonly pgVersion: string;
    /**
     * (string) - The DNS endpoint to connect to the instance for read+write access
     */
    readonly readWriteDns: string;
    /**
     * (string) - The current state of the instance. Possible values are: `AVAILABLE`, `DELETING`, `FAILING_OVER`, `STARTING`, `STOPPED`, `UPDATING`
     */
    readonly state: string;
    /**
     * (boolean) - Whether the instance is stopped
     */
    readonly stopped?: boolean;
    /**
     * (string) - An immutable UUID identifier for the instance
     */
    readonly uid: string;
}
/**
 * This data source can be used to get a single Database Instance.
 *
 * ## Example Usage
 *
 * Referring to a Database Instance by name:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const _this = databricks.getDatabaseInstance({
 *     name: "my-database-instance",
 * });
 * ```
 */
export declare function getDatabaseInstanceOutput(args: GetDatabaseInstanceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDatabaseInstanceResult>;
/**
 * A collection of arguments for invoking getDatabaseInstance.
 */
export interface GetDatabaseInstanceOutputArgs {
    /**
     * (string) - 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>;
    /**
     * (boolean) - Whether the instance is stopped
     */
    stopped?: pulumi.Input<boolean>;
}