@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
221 lines • 8.54 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Hive Databases in Biglake Metastore. Hive Databases exist within a Hive Catalog.
*
* > **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 HiveDatabase, see:
* * How-to Guides
* * [QUICKSTART_TITLE](https://docs.cloud.google.com/lakehouse/docs/about-spark-hive-metastore)
*
* ## Example Usage
*
* ### Biglake Hive Database
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const bucket = new gcp.storage.Bucket("bucket", {
* name: "example-bucket",
* location: "us-central1",
* forceDestroy: true,
* uniformBucketLevelAccess: true,
* });
* const catalog = new gcp.biglake.HiveCatalog("catalog", {
* name: "tf_test_catalog_81126",
* primaryLocation: "us-central1",
* locationUri: pulumi.interpolate`gs://${bucket.name}`,
* });
* const myHiveDatabase = new gcp.biglake.HiveDatabase("my_hive_database", {
* catalog: catalog.name,
* name: "tf_test_database_88717",
* locationUri: pulumi.interpolate`gs://${bucket.name}`,
* parameters: {
* key1: "value1",
* key2: "value2",
* },
* description: "hive database description",
* });
* ```
*
* ## Import
*
* HiveDatabase can be imported using any of these accepted formats:
*
* * `hive/v1beta/projects/{{project}}/catalogs/{{catalog}}/databases/{{name}}`
* * `{{project}}/{{catalog}}/{{name}}`
* * `{{catalog}}/{{name}}`
*
* When using the `pulumi import` command, HiveDatabase can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:biglake/hiveDatabase:HiveDatabase default hive/v1beta/projects/{{project}}/catalogs/{{catalog}}/databases/{{name}}
* $ pulumi import gcp:biglake/hiveDatabase:HiveDatabase default {{project}}/{{catalog}}/{{name}}
* $ pulumi import gcp:biglake/hiveDatabase:HiveDatabase default {{catalog}}/{{name}}
* ```
*/
export declare class HiveDatabase extends pulumi.CustomResource {
/**
* Get an existing HiveDatabase 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?: HiveDatabaseState, opts?: pulumi.CustomResourceOptions): HiveDatabase;
/**
* Returns true if the given object is an instance of HiveDatabase. 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 HiveDatabase;
/**
* Hive catalog where the database to create is located.
*/
readonly catalog: pulumi.Output<string>;
/**
* Output only. The creation time of the database.
*/
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 database.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Cloud Storage location path where the database exists. If unspecified, the database will be stored in the catalog location.
* Format: gs://bucket/path/to/database
*/
readonly locationUri: pulumi.Output<string | undefined>;
/**
* Database to create.
*/
readonly name: pulumi.Output<string>;
/**
* Additional parameters associated with the database.
*/
readonly parameters: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* 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 update time of the database.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a HiveDatabase 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: HiveDatabaseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering HiveDatabase resources.
*/
export interface HiveDatabaseState {
/**
* Hive catalog where the database to create is located.
*/
catalog?: pulumi.Input<string | undefined>;
/**
* Output only. The creation time of the database.
*/
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 database.
*/
description?: pulumi.Input<string | undefined>;
/**
* Cloud Storage location path where the database exists. If unspecified, the database will be stored in the catalog location.
* Format: gs://bucket/path/to/database
*/
locationUri?: pulumi.Input<string | undefined>;
/**
* Database to create.
*/
name?: pulumi.Input<string | undefined>;
/**
* Additional parameters associated with the database.
*/
parameters?: pulumi.Input<{
[key: string]: 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 update time of the database.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a HiveDatabase resource.
*/
export interface HiveDatabaseArgs {
/**
* Hive catalog where the database to create is located.
*/
catalog: pulumi.Input<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.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* Description of the database.
*/
description?: pulumi.Input<string | undefined>;
/**
* Cloud Storage location path where the database exists. If unspecified, the database will be stored in the catalog location.
* Format: gs://bucket/path/to/database
*/
locationUri?: pulumi.Input<string | undefined>;
/**
* Database to create.
*/
name?: pulumi.Input<string | undefined>;
/**
* Additional parameters associated with the database.
*/
parameters?: pulumi.Input<{
[key: string]: 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>;
}
//# sourceMappingURL=hiveDatabase.d.ts.map