@pulumi/databricks/databaseDatabaseCatalog.js

A Pulumi package for creating and managing databricks cloud resources.

"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.DatabaseDatabaseCatalog = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * Database Catalogs are databases inside a Lakebase Database Instance which are synced into a Postgres Catalog inside Unity Catalog.
 *
 * ## Example Usage
 *
 * ### Example
 *
 * This example creates a Database Catalog based on an existing database in the Database Instance
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const _this = new databricks.DatabaseDatabaseCatalog("this", {
 *     name: "my_registered_catalog",
 *     databaseInstanceName: "my-database-instance",
 *     databaseName: "databricks_postgres",
 * });
 * ```
 *
 * This example creates a Database Catalog along with a new database inside an existing Database Instance
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const _this = new databricks.DatabaseDatabaseCatalog("this", {
 *     name: "my_registered_catalog",
 *     databaseInstanceName: "my-database-instance",
 *     databaseName: "new_registered_catalog_database",
 *     createDatabaseIfNotExists: true,
 * });
 * ```
 *
 * This example creates a DatabaseInstance and then a Database Catalog inside it
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const instance = new databricks.DatabaseInstance("instance", {
 *     name: "my-database-instance",
 *     capacity: "CU_1",
 * });
 * const catalog = new databricks.DatabaseDatabaseCatalog("catalog", {
 *     name: "my_registered_catalog",
 *     databaseInstanceName: instance.name,
 *     databaseName: "new_registered_catalog_database",
 *     createDatabaseIfNotExists: true,
 * });
 * ```
 *
 * ## Import
 *
 * As of Pulumi v1.5, resources can be imported through configuration.
 *
 * hcl
 *
 * import {
 *
 *   id = "name"
 *
 *   to = databricks_database_database_catalog.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/databaseDatabaseCatalog:DatabaseDatabaseCatalog databricks_database_database_catalog "name"
 * ```
 */
class DatabaseDatabaseCatalog extends pulumi.CustomResource {
    /**
     * Get an existing DatabaseDatabaseCatalog 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, id, state, opts) {
        return new DatabaseDatabaseCatalog(name, state, { ...opts, id: id });
    }
    /**
     * Returns true if the given object is an instance of DatabaseDatabaseCatalog.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj) {
        if (obj === undefined || obj === null) {
            return false;
        }
        return obj['__pulumiType'] === DatabaseDatabaseCatalog.__pulumiType;
    }
    constructor(name, argsOrState, opts) {
        let resourceInputs = {};
        opts = opts || {};
        if (opts.id) {
            const state = argsOrState;
            resourceInputs["createDatabaseIfNotExists"] = state?.createDatabaseIfNotExists;
            resourceInputs["databaseInstanceName"] = state?.databaseInstanceName;
            resourceInputs["databaseName"] = state?.databaseName;
            resourceInputs["name"] = state?.name;
            resourceInputs["uid"] = state?.uid;
            resourceInputs["workspaceId"] = state?.workspaceId;
        }
        else {
            const args = argsOrState;
            if (args?.databaseInstanceName === undefined && !opts.urn) {
                throw new Error("Missing required property 'databaseInstanceName'");
            }
            if (args?.databaseName === undefined && !opts.urn) {
                throw new Error("Missing required property 'databaseName'");
            }
            resourceInputs["createDatabaseIfNotExists"] = args?.createDatabaseIfNotExists;
            resourceInputs["databaseInstanceName"] = args?.databaseInstanceName;
            resourceInputs["databaseName"] = args?.databaseName;
            resourceInputs["name"] = args?.name;
            resourceInputs["workspaceId"] = args?.workspaceId;
            resourceInputs["uid"] = undefined /*out*/;
        }
        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
        super(DatabaseDatabaseCatalog.__pulumiType, name, resourceInputs, opts);
    }
}
exports.DatabaseDatabaseCatalog = DatabaseDatabaseCatalog;
/** @internal */
DatabaseDatabaseCatalog.__pulumiType = 'databricks:index/databaseDatabaseCatalog:DatabaseDatabaseCatalog';
//# sourceMappingURL=databaseDatabaseCatalog.js.map