@pulumi/gcp/biglake/hiveCatalog.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Hive Catalogs in Biglake Metastore
 *
 * > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
 * See Provider Versions for more details on beta resources.
 *
 * To get more information about HiveCatalog, see:
 * * How-to Guides
 *     * [QUICKSTART_TITLE](https://docs.cloud.google.com/lakehouse/docs/about-spark-hive-metastore)
 *
 * ## Example Usage
 *
 * ### Biglake Hive Catalog
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const bucketForMyHiveCatalog = new gcp.storage.Bucket("bucket_for_my_hive_catalog", {
 *     name: "my_hive_catalog",
 *     location: "us-central1",
 *     forceDestroy: true,
 *     uniformBucketLevelAccess: true,
 * });
 * const myHiveCatalog = new gcp.biglake.HiveCatalog("my_hive_catalog", {
 *     name: "my_hive_catalog",
 *     primaryLocation: "us-central1",
 *     locationUri: pulumi.interpolate`gs://${bucketForMyHiveCatalog.name}`,
 * }, {
 *     dependsOn: [bucketForMyHiveCatalog],
 * });
 * ```
 * ### Biglake Hive Catalog Full
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const bucketForMyHiveCatalog = new gcp.storage.Bucket("bucket_for_my_hive_catalog", {
 *     name: "my_hive_catalog",
 *     location: "us-central1",
 *     forceDestroy: true,
 *     uniformBucketLevelAccess: true,
 * });
 * const myHiveCatalog = new gcp.biglake.HiveCatalog("my_hive_catalog", {
 *     name: "my_hive_catalog",
 *     primaryLocation: "us-central1",
 *     locationUri: pulumi.interpolate`gs://${bucketForMyHiveCatalog.name}`,
 *     description: "terraform test hive catalog",
 * }, {
 *     dependsOn: [bucketForMyHiveCatalog],
 * });
 * ```
 *
 * ## Import
 *
 * HiveCatalog can be imported using any of these accepted formats:
 *
 * * `hive/v1beta/projects/{{project}}/catalogs/{{name}}`
 * * `{{project}}/{{name}}`
 * * `{{name}}`
 *
 * When using the `pulumi import` command, HiveCatalog can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:biglake/hiveCatalog:HiveCatalog default hive/v1beta/projects/{{project}}/catalogs/{{name}}
 * $ pulumi import gcp:biglake/hiveCatalog:HiveCatalog default {{project}}/{{name}}
 * $ pulumi import gcp:biglake/hiveCatalog:HiveCatalog default {{name}}
 * ```
 */
export declare class HiveCatalog extends pulumi.CustomResource {
    /**
     * Get an existing HiveCatalog 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?: HiveCatalogState, opts?: pulumi.CustomResourceOptions): HiveCatalog;
    /**
     * Returns true if the given object is an instance of HiveCatalog.  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 HiveCatalog;
    /**
     * Output only. The creation time of the catalog.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    readonly deletionPolicy: pulumi.Output<string>;
    /**
     * Description of the Hive catalog.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
     */
    readonly locationUri: pulumi.Output<string>;
    /**
     * Name of the Hive Catalog.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The primary location for mirroring the remote catalog metadata. It must be
     * a BigLake-supported location, and it should be proximate to the remote
     * catalog's location.
     */
    readonly primaryLocation: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * Output only. The replicas for the catalog metadata.
     * Structure is documented below.
     */
    readonly replicas: pulumi.Output<outputs.biglake.HiveCatalogReplica[]>;
    /**
     * Output only. The update time of the catalog.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a HiveCatalog 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: HiveCatalogArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering HiveCatalog resources.
 */
export interface HiveCatalogState {
    /**
     * Output only. The creation time of the catalog.
     */
    createTime?: pulumi.Input<string | undefined>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * Description of the Hive catalog.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
     */
    locationUri?: pulumi.Input<string | undefined>;
    /**
     * Name of the Hive Catalog.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The primary location for mirroring the remote catalog metadata. It must be
     * a BigLake-supported location, and it should be proximate to the remote
     * catalog's location.
     */
    primaryLocation?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * Output only. The replicas for the catalog metadata.
     * Structure is documented below.
     */
    replicas?: pulumi.Input<pulumi.Input<inputs.biglake.HiveCatalogReplica>[] | undefined>;
    /**
     * Output only. The update time of the catalog.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a HiveCatalog resource.
 */
export interface HiveCatalogArgs {
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * Description of the Hive catalog.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
     */
    locationUri: pulumi.Input<string>;
    /**
     * Name of the Hive Catalog.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The primary location for mirroring the remote catalog metadata. It must be
     * a BigLake-supported location, and it should be proximate to the remote
     * catalog's location.
     */
    primaryLocation: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=hiveCatalog.d.ts.map