Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Google Cloud (GCP) Classic
  4. API Docs
  5. biglake
  6. HiveCatalog
Viewing docs for Google Cloud v9.30.0
published on Monday, Jul 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.biglake.HiveCatalog

gcp logo
Viewing docs for Google Cloud v9.30.0
published on Monday, Jul 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    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:

    Example Usage

    Biglake Hive Catalog

    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],
});

    import pulumi
import pulumi_gcp as gcp

bucket_for_my_hive_catalog = gcp.storage.Bucket("bucket_for_my_hive_catalog",
    name="my_hive_catalog",
    location="us-central1",
    force_destroy=True,
    uniform_bucket_level_access=True)
my_hive_catalog = gcp.biglake.HiveCatalog("my_hive_catalog",
    name="my_hive_catalog",
    primary_location="us-central1",
    location_uri=bucket_for_my_hive_catalog.name.apply(lambda name: f"gs://{name}"),
    opts = pulumi.ResourceOptions(depends_on=[bucket_for_my_hive_catalog]))

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/biglake"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		bucketForMyHiveCatalog, err := storage.NewBucket(ctx, "bucket_for_my_hive_catalog", &storage.BucketArgs{
			Name:                     pulumi.String("my_hive_catalog"),
			Location:                 pulumi.String("us-central1"),
			ForceDestroy:             pulumi.Bool(true),
			UniformBucketLevelAccess: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = biglake.NewHiveCatalog(ctx, "my_hive_catalog", &biglake.HiveCatalogArgs{
			Name:            pulumi.String("my_hive_catalog"),
			PrimaryLocation: pulumi.String("us-central1"),
			LocationUri: bucketForMyHiveCatalog.Name.ApplyT(func(name string) (string, error) {
				return fmt.Sprintf("gs://%v", name), nil
			}).(pulumi.StringOutput),
		}, pulumi.DependsOn([]pulumi.Resource{
			bucketForMyHiveCatalog,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var bucketForMyHiveCatalog = new Gcp.Storage.Bucket("bucket_for_my_hive_catalog", new()
    {
        Name = "my_hive_catalog",
        Location = "us-central1",
        ForceDestroy = true,
        UniformBucketLevelAccess = true,
    });

    var myHiveCatalog = new Gcp.BigLake.HiveCatalog("my_hive_catalog", new()
    {
        Name = "my_hive_catalog",
        PrimaryLocation = "us-central1",
        LocationUri = bucketForMyHiveCatalog.Name.Apply(name => $"gs://{name}"),
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            bucketForMyHiveCatalog,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.biglake.HiveCatalog;
import com.pulumi.gcp.biglake.HiveCatalogArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var bucketForMyHiveCatalog = new Bucket("bucketForMyHiveCatalog", BucketArgs.builder()
            .name("my_hive_catalog")
            .location("us-central1")
            .forceDestroy(true)
            .uniformBucketLevelAccess(true)
            .build());

        var myHiveCatalog = new HiveCatalog("myHiveCatalog", HiveCatalogArgs.builder()
            .name("my_hive_catalog")
            .primaryLocation("us-central1")
            .locationUri(bucketForMyHiveCatalog.name().applyValue(_name -> String.format("gs://%s", _name)))
            .build(), CustomResourceOptions.builder()
                .dependsOn(bucketForMyHiveCatalog)
                .build());

    }
}

    resources:
  bucketForMyHiveCatalog:
    type: gcp:storage:Bucket
    name: bucket_for_my_hive_catalog
    properties:
      name: my_hive_catalog
      location: us-central1
      forceDestroy: true
      uniformBucketLevelAccess: true
  myHiveCatalog:
    type: gcp:biglake:HiveCatalog
    name: my_hive_catalog
    properties:
      name: my_hive_catalog
      primaryLocation: us-central1
      locationUri: gs://${bucketForMyHiveCatalog.name}
    options:
      dependsOn:
        - ${bucketForMyHiveCatalog}

    pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_storage_bucket" "bucket_for_my_hive_catalog" {
  name                        = "my_hive_catalog"
  location                    = "us-central1"
  force_destroy               = true
  uniform_bucket_level_access = true
}
resource "gcp_biglake_hivecatalog" "my_hive_catalog" {
  depends_on       = [gcp_storage_bucket.bucket_for_my_hive_catalog]
  name             = "my_hive_catalog"
  primary_location = "us-central1"
  location_uri     ="gs://${gcp_storage_bucket.bucket_for_my_hive_catalog.name}"
}

    Biglake Hive Catalog Full

    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 pulumi
import pulumi_gcp as gcp

bucket_for_my_hive_catalog = gcp.storage.Bucket("bucket_for_my_hive_catalog",
    name="my_hive_catalog",
    location="us-central1",
    force_destroy=True,
    uniform_bucket_level_access=True)
my_hive_catalog = gcp.biglake.HiveCatalog("my_hive_catalog",
    name="my_hive_catalog",
    primary_location="us-central1",
    location_uri=bucket_for_my_hive_catalog.name.apply(lambda name: f"gs://{name}"),
    description="terraform test hive catalog",
    opts = pulumi.ResourceOptions(depends_on=[bucket_for_my_hive_catalog]))

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/biglake"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		bucketForMyHiveCatalog, err := storage.NewBucket(ctx, "bucket_for_my_hive_catalog", &storage.BucketArgs{
			Name:                     pulumi.String("my_hive_catalog"),
			Location:                 pulumi.String("us-central1"),
			ForceDestroy:             pulumi.Bool(true),
			UniformBucketLevelAccess: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = biglake.NewHiveCatalog(ctx, "my_hive_catalog", &biglake.HiveCatalogArgs{
			Name:            pulumi.String("my_hive_catalog"),
			PrimaryLocation: pulumi.String("us-central1"),
			LocationUri: bucketForMyHiveCatalog.Name.ApplyT(func(name string) (string, error) {
				return fmt.Sprintf("gs://%v", name), nil
			}).(pulumi.StringOutput),
			Description: pulumi.String("terraform test hive catalog"),
		}, pulumi.DependsOn([]pulumi.Resource{
			bucketForMyHiveCatalog,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var bucketForMyHiveCatalog = new Gcp.Storage.Bucket("bucket_for_my_hive_catalog", new()
    {
        Name = "my_hive_catalog",
        Location = "us-central1",
        ForceDestroy = true,
        UniformBucketLevelAccess = true,
    });

    var myHiveCatalog = new Gcp.BigLake.HiveCatalog("my_hive_catalog", new()
    {
        Name = "my_hive_catalog",
        PrimaryLocation = "us-central1",
        LocationUri = bucketForMyHiveCatalog.Name.Apply(name => $"gs://{name}"),
        Description = "terraform test hive catalog",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            bucketForMyHiveCatalog,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.biglake.HiveCatalog;
import com.pulumi.gcp.biglake.HiveCatalogArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var bucketForMyHiveCatalog = new Bucket("bucketForMyHiveCatalog", BucketArgs.builder()
            .name("my_hive_catalog")
            .location("us-central1")
            .forceDestroy(true)
            .uniformBucketLevelAccess(true)
            .build());

        var myHiveCatalog = new HiveCatalog("myHiveCatalog", HiveCatalogArgs.builder()
            .name("my_hive_catalog")
            .primaryLocation("us-central1")
            .locationUri(bucketForMyHiveCatalog.name().applyValue(_name -> String.format("gs://%s", _name)))
            .description("terraform test hive catalog")
            .build(), CustomResourceOptions.builder()
                .dependsOn(bucketForMyHiveCatalog)
                .build());

    }
}

    resources:
  bucketForMyHiveCatalog:
    type: gcp:storage:Bucket
    name: bucket_for_my_hive_catalog
    properties:
      name: my_hive_catalog
      location: us-central1
      forceDestroy: true
      uniformBucketLevelAccess: true
  myHiveCatalog:
    type: gcp:biglake:HiveCatalog
    name: my_hive_catalog
    properties:
      name: my_hive_catalog
      primaryLocation: us-central1
      locationUri: gs://${bucketForMyHiveCatalog.name}
      description: terraform test hive catalog
    options:
      dependsOn:
        - ${bucketForMyHiveCatalog}

    pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_storage_bucket" "bucket_for_my_hive_catalog" {
  name                        = "my_hive_catalog"
  location                    = "us-central1"
  force_destroy               = true
  uniform_bucket_level_access = true
}
resource "gcp_biglake_hivecatalog" "my_hive_catalog" {
  depends_on       = [gcp_storage_bucket.bucket_for_my_hive_catalog]
  name             = "my_hive_catalog"
  primary_location = "us-central1"
  location_uri     ="gs://${gcp_storage_bucket.bucket_for_my_hive_catalog.name}"
  description      = "terraform test hive catalog"
}

    Create HiveCatalog Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new HiveCatalog(name: string, args: HiveCatalogArgs, opts?: CustomResourceOptions);
    @overload
def HiveCatalog(resource_name: str,
                args: HiveCatalogArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def HiveCatalog(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                location_uri: Optional[str] = None,
                primary_location: Optional[str] = None,
                deletion_policy: Optional[str] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                project: Optional[str] = None)
    func NewHiveCatalog(ctx *Context, name string, args HiveCatalogArgs, opts ...ResourceOption) (*HiveCatalog, error)
    public HiveCatalog(string name, HiveCatalogArgs args, CustomResourceOptions? opts = null)
    public HiveCatalog(String name, HiveCatalogArgs args)
public HiveCatalog(String name, HiveCatalogArgs args, CustomResourceOptions options)

    type: gcp:biglake:HiveCatalog
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "gcp_biglake_hivecatalog" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args HiveCatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args HiveCatalogArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args HiveCatalogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HiveCatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HiveCatalogArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var hiveCatalogResource = new Gcp.BigLake.HiveCatalog("hiveCatalogResource", new()
{
    LocationUri = "string",
    PrimaryLocation = "string",
    DeletionPolicy = "string",
    Description = "string",
    Name = "string",
    Project = "string",
});

    example, err := biglake.NewHiveCatalog(ctx, "hiveCatalogResource", &biglake.HiveCatalogArgs{
	LocationUri:     pulumi.String("string"),
	PrimaryLocation: pulumi.String("string"),
	DeletionPolicy:  pulumi.String("string"),
	Description:     pulumi.String("string"),
	Name:            pulumi.String("string"),
	Project:         pulumi.String("string"),
})

    resource "gcp_biglake_hivecatalog" "hiveCatalogResource" {
  location_uri     = "string"
  primary_location = "string"
  deletion_policy  = "string"
  description      = "string"
  name             = "string"
  project          = "string"
}

    var hiveCatalogResource = new HiveCatalog("hiveCatalogResource", HiveCatalogArgs.builder()
    .locationUri("string")
    .primaryLocation("string")
    .deletionPolicy("string")
    .description("string")
    .name("string")
    .project("string")
    .build());

    hive_catalog_resource = gcp.biglake.HiveCatalog("hiveCatalogResource",
    location_uri="string",
    primary_location="string",
    deletion_policy="string",
    description="string",
    name="string",
    project="string")

    const hiveCatalogResource = new gcp.biglake.HiveCatalog("hiveCatalogResource", {
    locationUri: "string",
    primaryLocation: "string",
    deletionPolicy: "string",
    description: "string",
    name: "string",
    project: "string",
});

    type: gcp:biglake:HiveCatalog
properties:
    deletionPolicy: string
    description: string
    locationUri: string
    name: string
    primaryLocation: string
    project: string

    HiveCatalog Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The HiveCatalog resource accepts the following input properties:

    LocationUri string
    Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
    PrimaryLocation 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.
    DeletionPolicy 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.
    Description string
    Description of the Hive catalog.
    Name string
    Name of the Hive Catalog.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    LocationUri string
    Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
    PrimaryLocation 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.
    DeletionPolicy 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.
    Description string
    Description of the Hive catalog.
    Name string
    Name of the Hive Catalog.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location_uri string
    Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
    primary_location 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.
    deletion_policy 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.
    description string
    Description of the Hive catalog.
    name string
    Name of the Hive Catalog.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    locationUri String
    Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
    primaryLocation 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.
    deletionPolicy 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.
    description String
    Description of the Hive catalog.
    name String
    Name of the Hive Catalog.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    locationUri string
    Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
    primaryLocation 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.
    deletionPolicy 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.
    description string
    Description of the Hive catalog.
    name string
    Name of the Hive Catalog.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location_uri str
    Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
    primary_location str
    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.
    deletion_policy str
    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.
    description str
    Description of the Hive catalog.
    name str
    Name of the Hive Catalog.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    locationUri String
    Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
    primaryLocation 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.
    deletionPolicy 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.
    description String
    Description of the Hive catalog.
    name String
    Name of the Hive Catalog.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the HiveCatalog resource produces the following output properties:

    CreateTime string
    Output only. The creation time of the catalog.
    Id string
    The provider-assigned unique ID for this managed resource.
    Replicas List<HiveCatalogReplica>
    Output only. The replicas for the catalog metadata. Structure is documented below.
    UpdateTime string
    Output only. The update time of the catalog.
    CreateTime string
    Output only. The creation time of the catalog.
    Id string
    The provider-assigned unique ID for this managed resource.
    Replicas []HiveCatalogReplica
    Output only. The replicas for the catalog metadata. Structure is documented below.
    UpdateTime string
    Output only. The update time of the catalog.
    create_time string
    Output only. The creation time of the catalog.
    id string
    The provider-assigned unique ID for this managed resource.
    replicas list(object)
    Output only. The replicas for the catalog metadata. Structure is documented below.
    update_time string
    Output only. The update time of the catalog.
    createTime String
    Output only. The creation time of the catalog.
    id String
    The provider-assigned unique ID for this managed resource.
    replicas List<HiveCatalogReplica>
    Output only. The replicas for the catalog metadata. Structure is documented below.
    updateTime String
    Output only. The update time of the catalog.
    createTime string
    Output only. The creation time of the catalog.
    id string
    The provider-assigned unique ID for this managed resource.
    replicas HiveCatalogReplica[]
    Output only. The replicas for the catalog metadata. Structure is documented below.
    updateTime string
    Output only. The update time of the catalog.
    create_time str
    Output only. The creation time of the catalog.
    id str
    The provider-assigned unique ID for this managed resource.
    replicas Sequence[HiveCatalogReplica]
    Output only. The replicas for the catalog metadata. Structure is documented below.
    update_time str
    Output only. The update time of the catalog.
    createTime String
    Output only. The creation time of the catalog.
    id String
    The provider-assigned unique ID for this managed resource.
    replicas List<Property Map>
    Output only. The replicas for the catalog metadata. Structure is documented below.
    updateTime String
    Output only. The update time of the catalog.

    Look up Existing HiveCatalog Resource

    Get an existing HiveCatalog resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: HiveCatalogState, opts?: CustomResourceOptions): HiveCatalog
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        deletion_policy: Optional[str] = None,
        description: Optional[str] = None,
        location_uri: Optional[str] = None,
        name: Optional[str] = None,
        primary_location: Optional[str] = None,
        project: Optional[str] = None,
        replicas: Optional[Sequence[HiveCatalogReplicaArgs]] = None,
        update_time: Optional[str] = None) -> HiveCatalog
    func GetHiveCatalog(ctx *Context, name string, id IDInput, state *HiveCatalogState, opts ...ResourceOption) (*HiveCatalog, error)
    public static HiveCatalog Get(string name, Input<string> id, HiveCatalogState? state, CustomResourceOptions? opts = null)
    public static HiveCatalog get(String name, Output<String> id, HiveCatalogState state, CustomResourceOptions options)
    resources:  _:    type: gcp:biglake:HiveCatalog    get:      id: ${id}
    import {
  to = gcp_biglake_hivecatalog.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreateTime string
    Output only. The creation time of the catalog.
    DeletionPolicy 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.
    Description string
    Description of the Hive catalog.
    LocationUri string
    Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
    Name string
    Name of the Hive Catalog.
    PrimaryLocation 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Replicas List<HiveCatalogReplica>
    Output only. The replicas for the catalog metadata. Structure is documented below.
    UpdateTime string
    Output only. The update time of the catalog.
    CreateTime string
    Output only. The creation time of the catalog.
    DeletionPolicy 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.
    Description string
    Description of the Hive catalog.
    LocationUri string
    Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
    Name string
    Name of the Hive Catalog.
    PrimaryLocation 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Replicas []HiveCatalogReplicaArgs
    Output only. The replicas for the catalog metadata. Structure is documented below.
    UpdateTime string
    Output only. The update time of the catalog.
    create_time string
    Output only. The creation time of the catalog.
    deletion_policy 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.
    description string
    Description of the Hive catalog.
    location_uri string
    Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
    name string
    Name of the Hive Catalog.
    primary_location 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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replicas list(object)
    Output only. The replicas for the catalog metadata. Structure is documented below.
    update_time string
    Output only. The update time of the catalog.
    createTime String
    Output only. The creation time of the catalog.
    deletionPolicy 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.
    description String
    Description of the Hive catalog.
    locationUri String
    Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
    name String
    Name of the Hive Catalog.
    primaryLocation 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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replicas List<HiveCatalogReplica>
    Output only. The replicas for the catalog metadata. Structure is documented below.
    updateTime String
    Output only. The update time of the catalog.
    createTime string
    Output only. The creation time of the catalog.
    deletionPolicy 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.
    description string
    Description of the Hive catalog.
    locationUri string
    Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
    name string
    Name of the Hive Catalog.
    primaryLocation 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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replicas HiveCatalogReplica[]
    Output only. The replicas for the catalog metadata. Structure is documented below.
    updateTime string
    Output only. The update time of the catalog.
    create_time str
    Output only. The creation time of the catalog.
    deletion_policy str
    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.
    description str
    Description of the Hive catalog.
    location_uri str
    Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
    name str
    Name of the Hive Catalog.
    primary_location str
    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.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replicas Sequence[HiveCatalogReplicaArgs]
    Output only. The replicas for the catalog metadata. Structure is documented below.
    update_time str
    Output only. The update time of the catalog.
    createTime String
    Output only. The creation time of the catalog.
    deletionPolicy 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.
    description String
    Description of the Hive catalog.
    locationUri String
    Cloud Storage location path where the catalog data will be stored. Format: gs://bucket/path/to/catalog
    name String
    Name of the Hive Catalog.
    primaryLocation 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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replicas List<Property Map>
    Output only. The replicas for the catalog metadata. Structure is documented below.
    updateTime String
    Output only. The update time of the catalog.

    Supporting Types

    HiveCatalogReplica, HiveCatalogReplicaArgs

    Region string
    (Output) The region of the replica, e.g., us-east1.
    State string
    (Output) If the catalog is replicated to multiple regions, this enum describes the current state of the replica. STATE_UNSPECIFIED - The replica state is unknown. STATE_PRIMARY - The replica is the writable primary. STATE_PRIMARY_IN_PROGRESS - The replica has been recently assigned as the primary, but not all databases are writeable yet. STATE_SECONDARY - The replica is a read-only secondary replica.
    Region string
    (Output) The region of the replica, e.g., us-east1.
    State string
    (Output) If the catalog is replicated to multiple regions, this enum describes the current state of the replica. STATE_UNSPECIFIED - The replica state is unknown. STATE_PRIMARY - The replica is the writable primary. STATE_PRIMARY_IN_PROGRESS - The replica has been recently assigned as the primary, but not all databases are writeable yet. STATE_SECONDARY - The replica is a read-only secondary replica.
    region string
    (Output) The region of the replica, e.g., us-east1.
    state string
    (Output) If the catalog is replicated to multiple regions, this enum describes the current state of the replica. STATE_UNSPECIFIED - The replica state is unknown. STATE_PRIMARY - The replica is the writable primary. STATE_PRIMARY_IN_PROGRESS - The replica has been recently assigned as the primary, but not all databases are writeable yet. STATE_SECONDARY - The replica is a read-only secondary replica.
    region String
    (Output) The region of the replica, e.g., us-east1.
    state String
    (Output) If the catalog is replicated to multiple regions, this enum describes the current state of the replica. STATE_UNSPECIFIED - The replica state is unknown. STATE_PRIMARY - The replica is the writable primary. STATE_PRIMARY_IN_PROGRESS - The replica has been recently assigned as the primary, but not all databases are writeable yet. STATE_SECONDARY - The replica is a read-only secondary replica.
    region string
    (Output) The region of the replica, e.g., us-east1.
    state string
    (Output) If the catalog is replicated to multiple regions, this enum describes the current state of the replica. STATE_UNSPECIFIED - The replica state is unknown. STATE_PRIMARY - The replica is the writable primary. STATE_PRIMARY_IN_PROGRESS - The replica has been recently assigned as the primary, but not all databases are writeable yet. STATE_SECONDARY - The replica is a read-only secondary replica.
    region str
    (Output) The region of the replica, e.g., us-east1.
    state str
    (Output) If the catalog is replicated to multiple regions, this enum describes the current state of the replica. STATE_UNSPECIFIED - The replica state is unknown. STATE_PRIMARY - The replica is the writable primary. STATE_PRIMARY_IN_PROGRESS - The replica has been recently assigned as the primary, but not all databases are writeable yet. STATE_SECONDARY - The replica is a read-only secondary replica.
    region String
    (Output) The region of the replica, e.g., us-east1.
    state String
    (Output) If the catalog is replicated to multiple regions, this enum describes the current state of the replica. STATE_UNSPECIFIED - The replica state is unknown. STATE_PRIMARY - The replica is the writable primary. STATE_PRIMARY_IN_PROGRESS - The replica has been recently assigned as the primary, but not all databases are writeable yet. STATE_SECONDARY - The replica is a read-only secondary replica.

    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:

    $ 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}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Viewing docs for Google Cloud v9.30.0
    published on Monday, Jul 13, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gcp

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial