1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. biglake
  5. IcebergCatalog
Google Cloud v9.10.0 published on Friday, Jan 16, 2026 by Pulumi
gcp logo
Google Cloud v9.10.0 published on Friday, Jan 16, 2026 by Pulumi

    IcebergCatalogs are top-level containers for Apache Iceberg REST Catalog served Namespaces and Tables.

    To get more information about IcebergCatalog, see:

    Warning: If you are using User ADCs (Application Default Credentials) with this resource’s IAM, you must specify a billing_project and set user_project_override to true in the provider configuration. Otherwise the IAM API will return 403s. Your account must have the serviceusage.services.use permission on the billing_project you defined.

    Example Usage

    Biglake Iceberg Catalog

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const bucketForMyIcebergCatalog = new gcp.storage.Bucket("bucket_for_my_iceberg_catalog", {
        name: "my_iceberg_catalog",
        location: "us-central1",
        forceDestroy: true,
        uniformBucketLevelAccess: true,
    });
    const myIcebergCatalog = new gcp.biglake.IcebergCatalog("my_iceberg_catalog", {
        name: "my_iceberg_catalog",
        catalogType: "CATALOG_TYPE_GCS_BUCKET",
    }, {
        dependsOn: [bucketForMyIcebergCatalog],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    bucket_for_my_iceberg_catalog = gcp.storage.Bucket("bucket_for_my_iceberg_catalog",
        name="my_iceberg_catalog",
        location="us-central1",
        force_destroy=True,
        uniform_bucket_level_access=True)
    my_iceberg_catalog = gcp.biglake.IcebergCatalog("my_iceberg_catalog",
        name="my_iceberg_catalog",
        catalog_type="CATALOG_TYPE_GCS_BUCKET",
        opts = pulumi.ResourceOptions(depends_on=[bucket_for_my_iceberg_catalog]))
    
    package main
    
    import (
    	"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 {
    		bucketForMyIcebergCatalog, err := storage.NewBucket(ctx, "bucket_for_my_iceberg_catalog", &storage.BucketArgs{
    			Name:                     pulumi.String("my_iceberg_catalog"),
    			Location:                 pulumi.String("us-central1"),
    			ForceDestroy:             pulumi.Bool(true),
    			UniformBucketLevelAccess: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = biglake.NewIcebergCatalog(ctx, "my_iceberg_catalog", &biglake.IcebergCatalogArgs{
    			Name:        pulumi.String("my_iceberg_catalog"),
    			CatalogType: pulumi.String("CATALOG_TYPE_GCS_BUCKET"),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			bucketForMyIcebergCatalog,
    		}))
    		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 bucketForMyIcebergCatalog = new Gcp.Storage.Bucket("bucket_for_my_iceberg_catalog", new()
        {
            Name = "my_iceberg_catalog",
            Location = "us-central1",
            ForceDestroy = true,
            UniformBucketLevelAccess = true,
        });
    
        var myIcebergCatalog = new Gcp.BigLake.IcebergCatalog("my_iceberg_catalog", new()
        {
            Name = "my_iceberg_catalog",
            CatalogType = "CATALOG_TYPE_GCS_BUCKET",
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                bucketForMyIcebergCatalog,
            },
        });
    
    });
    
    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.IcebergCatalog;
    import com.pulumi.gcp.biglake.IcebergCatalogArgs;
    import com.pulumi.resources.CustomResourceOptions;
    import java.util.List;
    import java.util.ArrayList;
    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 bucketForMyIcebergCatalog = new Bucket("bucketForMyIcebergCatalog", BucketArgs.builder()
                .name("my_iceberg_catalog")
                .location("us-central1")
                .forceDestroy(true)
                .uniformBucketLevelAccess(true)
                .build());
    
            var myIcebergCatalog = new IcebergCatalog("myIcebergCatalog", IcebergCatalogArgs.builder()
                .name("my_iceberg_catalog")
                .catalogType("CATALOG_TYPE_GCS_BUCKET")
                .build(), CustomResourceOptions.builder()
                    .dependsOn(bucketForMyIcebergCatalog)
                    .build());
    
        }
    }
    
    resources:
      bucketForMyIcebergCatalog:
        type: gcp:storage:Bucket
        name: bucket_for_my_iceberg_catalog
        properties:
          name: my_iceberg_catalog
          location: us-central1
          forceDestroy: true
          uniformBucketLevelAccess: true
      myIcebergCatalog:
        type: gcp:biglake:IcebergCatalog
        name: my_iceberg_catalog
        properties:
          name: my_iceberg_catalog
          catalogType: CATALOG_TYPE_GCS_BUCKET
        options:
          dependsOn:
            - ${bucketForMyIcebergCatalog}
    

    Create IcebergCatalog Resource

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

    Constructor syntax

    new IcebergCatalog(name: string, args: IcebergCatalogArgs, opts?: CustomResourceOptions);
    @overload
    def IcebergCatalog(resource_name: str,
                       args: IcebergCatalogArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def IcebergCatalog(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       catalog_type: Optional[str] = None,
                       credential_mode: Optional[str] = None,
                       name: Optional[str] = None,
                       project: Optional[str] = None)
    func NewIcebergCatalog(ctx *Context, name string, args IcebergCatalogArgs, opts ...ResourceOption) (*IcebergCatalog, error)
    public IcebergCatalog(string name, IcebergCatalogArgs args, CustomResourceOptions? opts = null)
    public IcebergCatalog(String name, IcebergCatalogArgs args)
    public IcebergCatalog(String name, IcebergCatalogArgs args, CustomResourceOptions options)
    
    type: gcp:biglake:IcebergCatalog
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args IcebergCatalogArgs
    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 IcebergCatalogArgs
    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 IcebergCatalogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IcebergCatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IcebergCatalogArgs
    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 icebergCatalogResource = new Gcp.BigLake.IcebergCatalog("icebergCatalogResource", new()
    {
        CatalogType = "string",
        CredentialMode = "string",
        Name = "string",
        Project = "string",
    });
    
    example, err := biglake.NewIcebergCatalog(ctx, "icebergCatalogResource", &biglake.IcebergCatalogArgs{
    	CatalogType:    pulumi.String("string"),
    	CredentialMode: pulumi.String("string"),
    	Name:           pulumi.String("string"),
    	Project:        pulumi.String("string"),
    })
    
    var icebergCatalogResource = new IcebergCatalog("icebergCatalogResource", IcebergCatalogArgs.builder()
        .catalogType("string")
        .credentialMode("string")
        .name("string")
        .project("string")
        .build());
    
    iceberg_catalog_resource = gcp.biglake.IcebergCatalog("icebergCatalogResource",
        catalog_type="string",
        credential_mode="string",
        name="string",
        project="string")
    
    const icebergCatalogResource = new gcp.biglake.IcebergCatalog("icebergCatalogResource", {
        catalogType: "string",
        credentialMode: "string",
        name: "string",
        project: "string",
    });
    
    type: gcp:biglake:IcebergCatalog
    properties:
        catalogType: string
        credentialMode: string
        name: string
        project: string
    

    IcebergCatalog 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 IcebergCatalog resource accepts the following input properties:

    CatalogType string
    The catalog type of the IcebergCatalog. Currently only supports the type for Google Cloud Storage Buckets. Possible values are: CATALOG_TYPE_GCS_BUCKET.
    CredentialMode string
    The credential mode used for the catalog. CREDENTIAL_MODE_END_USER - End user credentials, default. The authenticating user must have access to the catalog resources and the corresponding Google Cloud Storage files. CREDENTIAL_MODE_VENDED_CREDENTIALS - Use credential vending. The authenticating user must have access to the catalog resources and the system will provide the caller with downscoped credentials to access the Google Cloud Storage files. All table operations in this mode would require X-Iceberg-Access-Delegation header with vended-credentials value included. System will generate a service account and the catalog administrator must grant the service account appropriate permissions. Possible values are: CREDENTIAL_MODE_END_USER, CREDENTIAL_MODE_VENDED_CREDENTIALS.
    Name string
    The name of the IcebergCatalog. Format: projects/{project_id_or_number}/catalogs/{iceberg_catalog_id}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    CatalogType string
    The catalog type of the IcebergCatalog. Currently only supports the type for Google Cloud Storage Buckets. Possible values are: CATALOG_TYPE_GCS_BUCKET.
    CredentialMode string
    The credential mode used for the catalog. CREDENTIAL_MODE_END_USER - End user credentials, default. The authenticating user must have access to the catalog resources and the corresponding Google Cloud Storage files. CREDENTIAL_MODE_VENDED_CREDENTIALS - Use credential vending. The authenticating user must have access to the catalog resources and the system will provide the caller with downscoped credentials to access the Google Cloud Storage files. All table operations in this mode would require X-Iceberg-Access-Delegation header with vended-credentials value included. System will generate a service account and the catalog administrator must grant the service account appropriate permissions. Possible values are: CREDENTIAL_MODE_END_USER, CREDENTIAL_MODE_VENDED_CREDENTIALS.
    Name string
    The name of the IcebergCatalog. Format: projects/{project_id_or_number}/catalogs/{iceberg_catalog_id}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    catalogType String
    The catalog type of the IcebergCatalog. Currently only supports the type for Google Cloud Storage Buckets. Possible values are: CATALOG_TYPE_GCS_BUCKET.
    credentialMode String
    The credential mode used for the catalog. CREDENTIAL_MODE_END_USER - End user credentials, default. The authenticating user must have access to the catalog resources and the corresponding Google Cloud Storage files. CREDENTIAL_MODE_VENDED_CREDENTIALS - Use credential vending. The authenticating user must have access to the catalog resources and the system will provide the caller with downscoped credentials to access the Google Cloud Storage files. All table operations in this mode would require X-Iceberg-Access-Delegation header with vended-credentials value included. System will generate a service account and the catalog administrator must grant the service account appropriate permissions. Possible values are: CREDENTIAL_MODE_END_USER, CREDENTIAL_MODE_VENDED_CREDENTIALS.
    name String
    The name of the IcebergCatalog. Format: projects/{project_id_or_number}/catalogs/{iceberg_catalog_id}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    catalogType string
    The catalog type of the IcebergCatalog. Currently only supports the type for Google Cloud Storage Buckets. Possible values are: CATALOG_TYPE_GCS_BUCKET.
    credentialMode string
    The credential mode used for the catalog. CREDENTIAL_MODE_END_USER - End user credentials, default. The authenticating user must have access to the catalog resources and the corresponding Google Cloud Storage files. CREDENTIAL_MODE_VENDED_CREDENTIALS - Use credential vending. The authenticating user must have access to the catalog resources and the system will provide the caller with downscoped credentials to access the Google Cloud Storage files. All table operations in this mode would require X-Iceberg-Access-Delegation header with vended-credentials value included. System will generate a service account and the catalog administrator must grant the service account appropriate permissions. Possible values are: CREDENTIAL_MODE_END_USER, CREDENTIAL_MODE_VENDED_CREDENTIALS.
    name string
    The name of the IcebergCatalog. Format: projects/{project_id_or_number}/catalogs/{iceberg_catalog_id}
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    catalog_type str
    The catalog type of the IcebergCatalog. Currently only supports the type for Google Cloud Storage Buckets. Possible values are: CATALOG_TYPE_GCS_BUCKET.
    credential_mode str
    The credential mode used for the catalog. CREDENTIAL_MODE_END_USER - End user credentials, default. The authenticating user must have access to the catalog resources and the corresponding Google Cloud Storage files. CREDENTIAL_MODE_VENDED_CREDENTIALS - Use credential vending. The authenticating user must have access to the catalog resources and the system will provide the caller with downscoped credentials to access the Google Cloud Storage files. All table operations in this mode would require X-Iceberg-Access-Delegation header with vended-credentials value included. System will generate a service account and the catalog administrator must grant the service account appropriate permissions. Possible values are: CREDENTIAL_MODE_END_USER, CREDENTIAL_MODE_VENDED_CREDENTIALS.
    name str
    The name of the IcebergCatalog. Format: projects/{project_id_or_number}/catalogs/{iceberg_catalog_id}
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    catalogType String
    The catalog type of the IcebergCatalog. Currently only supports the type for Google Cloud Storage Buckets. Possible values are: CATALOG_TYPE_GCS_BUCKET.
    credentialMode String
    The credential mode used for the catalog. CREDENTIAL_MODE_END_USER - End user credentials, default. The authenticating user must have access to the catalog resources and the corresponding Google Cloud Storage files. CREDENTIAL_MODE_VENDED_CREDENTIALS - Use credential vending. The authenticating user must have access to the catalog resources and the system will provide the caller with downscoped credentials to access the Google Cloud Storage files. All table operations in this mode would require X-Iceberg-Access-Delegation header with vended-credentials value included. System will generate a service account and the catalog administrator must grant the service account appropriate permissions. Possible values are: CREDENTIAL_MODE_END_USER, CREDENTIAL_MODE_VENDED_CREDENTIALS.
    name String
    The name of the IcebergCatalog. Format: projects/{project_id_or_number}/catalogs/{iceberg_catalog_id}
    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 IcebergCatalog resource produces the following output properties:

    BiglakeServiceAccount string
    Output only. The service account used for credential vending. It might be empty if credential vending was never enabled for the catalog.
    CreateTime string
    Output only. The creation time of the IcebergCatalog.
    DefaultLocation string
    Output only. The default storage location for the catalog, e.g., gs://my-bucket.
    Id string
    The provider-assigned unique ID for this managed resource.
    Replicas List<IcebergCatalogReplica>
    Output only. The replicas for the catalog metadata. Structure is documented below.
    StorageRegions List<string>
    Output only. The GCP region(s) where the physical metadata for the tables is stored, e.g. us-central1, nam4 or us. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.
    UpdateTime string
    Output only. The last modification time of the IcebergCatalog.
    BiglakeServiceAccount string
    Output only. The service account used for credential vending. It might be empty if credential vending was never enabled for the catalog.
    CreateTime string
    Output only. The creation time of the IcebergCatalog.
    DefaultLocation string
    Output only. The default storage location for the catalog, e.g., gs://my-bucket.
    Id string
    The provider-assigned unique ID for this managed resource.
    Replicas []IcebergCatalogReplica
    Output only. The replicas for the catalog metadata. Structure is documented below.
    StorageRegions []string
    Output only. The GCP region(s) where the physical metadata for the tables is stored, e.g. us-central1, nam4 or us. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.
    UpdateTime string
    Output only. The last modification time of the IcebergCatalog.
    biglakeServiceAccount String
    Output only. The service account used for credential vending. It might be empty if credential vending was never enabled for the catalog.
    createTime String
    Output only. The creation time of the IcebergCatalog.
    defaultLocation String
    Output only. The default storage location for the catalog, e.g., gs://my-bucket.
    id String
    The provider-assigned unique ID for this managed resource.
    replicas List<IcebergCatalogReplica>
    Output only. The replicas for the catalog metadata. Structure is documented below.
    storageRegions List<String>
    Output only. The GCP region(s) where the physical metadata for the tables is stored, e.g. us-central1, nam4 or us. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.
    updateTime String
    Output only. The last modification time of the IcebergCatalog.
    biglakeServiceAccount string
    Output only. The service account used for credential vending. It might be empty if credential vending was never enabled for the catalog.
    createTime string
    Output only. The creation time of the IcebergCatalog.
    defaultLocation string
    Output only. The default storage location for the catalog, e.g., gs://my-bucket.
    id string
    The provider-assigned unique ID for this managed resource.
    replicas IcebergCatalogReplica[]
    Output only. The replicas for the catalog metadata. Structure is documented below.
    storageRegions string[]
    Output only. The GCP region(s) where the physical metadata for the tables is stored, e.g. us-central1, nam4 or us. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.
    updateTime string
    Output only. The last modification time of the IcebergCatalog.
    biglake_service_account str
    Output only. The service account used for credential vending. It might be empty if credential vending was never enabled for the catalog.
    create_time str
    Output only. The creation time of the IcebergCatalog.
    default_location str
    Output only. The default storage location for the catalog, e.g., gs://my-bucket.
    id str
    The provider-assigned unique ID for this managed resource.
    replicas Sequence[IcebergCatalogReplica]
    Output only. The replicas for the catalog metadata. Structure is documented below.
    storage_regions Sequence[str]
    Output only. The GCP region(s) where the physical metadata for the tables is stored, e.g. us-central1, nam4 or us. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.
    update_time str
    Output only. The last modification time of the IcebergCatalog.
    biglakeServiceAccount String
    Output only. The service account used for credential vending. It might be empty if credential vending was never enabled for the catalog.
    createTime String
    Output only. The creation time of the IcebergCatalog.
    defaultLocation String
    Output only. The default storage location for the catalog, e.g., gs://my-bucket.
    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.
    storageRegions List<String>
    Output only. The GCP region(s) where the physical metadata for the tables is stored, e.g. us-central1, nam4 or us. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.
    updateTime String
    Output only. The last modification time of the IcebergCatalog.

    Look up Existing IcebergCatalog Resource

    Get an existing IcebergCatalog 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?: IcebergCatalogState, opts?: CustomResourceOptions): IcebergCatalog
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            biglake_service_account: Optional[str] = None,
            catalog_type: Optional[str] = None,
            create_time: Optional[str] = None,
            credential_mode: Optional[str] = None,
            default_location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            replicas: Optional[Sequence[IcebergCatalogReplicaArgs]] = None,
            storage_regions: Optional[Sequence[str]] = None,
            update_time: Optional[str] = None) -> IcebergCatalog
    func GetIcebergCatalog(ctx *Context, name string, id IDInput, state *IcebergCatalogState, opts ...ResourceOption) (*IcebergCatalog, error)
    public static IcebergCatalog Get(string name, Input<string> id, IcebergCatalogState? state, CustomResourceOptions? opts = null)
    public static IcebergCatalog get(String name, Output<String> id, IcebergCatalogState state, CustomResourceOptions options)
    resources:  _:    type: gcp:biglake:IcebergCatalog    get:      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:
    BiglakeServiceAccount string
    Output only. The service account used for credential vending. It might be empty if credential vending was never enabled for the catalog.
    CatalogType string
    The catalog type of the IcebergCatalog. Currently only supports the type for Google Cloud Storage Buckets. Possible values are: CATALOG_TYPE_GCS_BUCKET.
    CreateTime string
    Output only. The creation time of the IcebergCatalog.
    CredentialMode string
    The credential mode used for the catalog. CREDENTIAL_MODE_END_USER - End user credentials, default. The authenticating user must have access to the catalog resources and the corresponding Google Cloud Storage files. CREDENTIAL_MODE_VENDED_CREDENTIALS - Use credential vending. The authenticating user must have access to the catalog resources and the system will provide the caller with downscoped credentials to access the Google Cloud Storage files. All table operations in this mode would require X-Iceberg-Access-Delegation header with vended-credentials value included. System will generate a service account and the catalog administrator must grant the service account appropriate permissions. Possible values are: CREDENTIAL_MODE_END_USER, CREDENTIAL_MODE_VENDED_CREDENTIALS.
    DefaultLocation string
    Output only. The default storage location for the catalog, e.g., gs://my-bucket.
    Name string
    The name of the IcebergCatalog. Format: projects/{project_id_or_number}/catalogs/{iceberg_catalog_id}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Replicas List<IcebergCatalogReplica>
    Output only. The replicas for the catalog metadata. Structure is documented below.
    StorageRegions List<string>
    Output only. The GCP region(s) where the physical metadata for the tables is stored, e.g. us-central1, nam4 or us. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.
    UpdateTime string
    Output only. The last modification time of the IcebergCatalog.
    BiglakeServiceAccount string
    Output only. The service account used for credential vending. It might be empty if credential vending was never enabled for the catalog.
    CatalogType string
    The catalog type of the IcebergCatalog. Currently only supports the type for Google Cloud Storage Buckets. Possible values are: CATALOG_TYPE_GCS_BUCKET.
    CreateTime string
    Output only. The creation time of the IcebergCatalog.
    CredentialMode string
    The credential mode used for the catalog. CREDENTIAL_MODE_END_USER - End user credentials, default. The authenticating user must have access to the catalog resources and the corresponding Google Cloud Storage files. CREDENTIAL_MODE_VENDED_CREDENTIALS - Use credential vending. The authenticating user must have access to the catalog resources and the system will provide the caller with downscoped credentials to access the Google Cloud Storage files. All table operations in this mode would require X-Iceberg-Access-Delegation header with vended-credentials value included. System will generate a service account and the catalog administrator must grant the service account appropriate permissions. Possible values are: CREDENTIAL_MODE_END_USER, CREDENTIAL_MODE_VENDED_CREDENTIALS.
    DefaultLocation string
    Output only. The default storage location for the catalog, e.g., gs://my-bucket.
    Name string
    The name of the IcebergCatalog. Format: projects/{project_id_or_number}/catalogs/{iceberg_catalog_id}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Replicas []IcebergCatalogReplicaArgs
    Output only. The replicas for the catalog metadata. Structure is documented below.
    StorageRegions []string
    Output only. The GCP region(s) where the physical metadata for the tables is stored, e.g. us-central1, nam4 or us. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.
    UpdateTime string
    Output only. The last modification time of the IcebergCatalog.
    biglakeServiceAccount String
    Output only. The service account used for credential vending. It might be empty if credential vending was never enabled for the catalog.
    catalogType String
    The catalog type of the IcebergCatalog. Currently only supports the type for Google Cloud Storage Buckets. Possible values are: CATALOG_TYPE_GCS_BUCKET.
    createTime String
    Output only. The creation time of the IcebergCatalog.
    credentialMode String
    The credential mode used for the catalog. CREDENTIAL_MODE_END_USER - End user credentials, default. The authenticating user must have access to the catalog resources and the corresponding Google Cloud Storage files. CREDENTIAL_MODE_VENDED_CREDENTIALS - Use credential vending. The authenticating user must have access to the catalog resources and the system will provide the caller with downscoped credentials to access the Google Cloud Storage files. All table operations in this mode would require X-Iceberg-Access-Delegation header with vended-credentials value included. System will generate a service account and the catalog administrator must grant the service account appropriate permissions. Possible values are: CREDENTIAL_MODE_END_USER, CREDENTIAL_MODE_VENDED_CREDENTIALS.
    defaultLocation String
    Output only. The default storage location for the catalog, e.g., gs://my-bucket.
    name String
    The name of the IcebergCatalog. Format: projects/{project_id_or_number}/catalogs/{iceberg_catalog_id}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replicas List<IcebergCatalogReplica>
    Output only. The replicas for the catalog metadata. Structure is documented below.
    storageRegions List<String>
    Output only. The GCP region(s) where the physical metadata for the tables is stored, e.g. us-central1, nam4 or us. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.
    updateTime String
    Output only. The last modification time of the IcebergCatalog.
    biglakeServiceAccount string
    Output only. The service account used for credential vending. It might be empty if credential vending was never enabled for the catalog.
    catalogType string
    The catalog type of the IcebergCatalog. Currently only supports the type for Google Cloud Storage Buckets. Possible values are: CATALOG_TYPE_GCS_BUCKET.
    createTime string
    Output only. The creation time of the IcebergCatalog.
    credentialMode string
    The credential mode used for the catalog. CREDENTIAL_MODE_END_USER - End user credentials, default. The authenticating user must have access to the catalog resources and the corresponding Google Cloud Storage files. CREDENTIAL_MODE_VENDED_CREDENTIALS - Use credential vending. The authenticating user must have access to the catalog resources and the system will provide the caller with downscoped credentials to access the Google Cloud Storage files. All table operations in this mode would require X-Iceberg-Access-Delegation header with vended-credentials value included. System will generate a service account and the catalog administrator must grant the service account appropriate permissions. Possible values are: CREDENTIAL_MODE_END_USER, CREDENTIAL_MODE_VENDED_CREDENTIALS.
    defaultLocation string
    Output only. The default storage location for the catalog, e.g., gs://my-bucket.
    name string
    The name of the IcebergCatalog. Format: projects/{project_id_or_number}/catalogs/{iceberg_catalog_id}
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replicas IcebergCatalogReplica[]
    Output only. The replicas for the catalog metadata. Structure is documented below.
    storageRegions string[]
    Output only. The GCP region(s) where the physical metadata for the tables is stored, e.g. us-central1, nam4 or us. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.
    updateTime string
    Output only. The last modification time of the IcebergCatalog.
    biglake_service_account str
    Output only. The service account used for credential vending. It might be empty if credential vending was never enabled for the catalog.
    catalog_type str
    The catalog type of the IcebergCatalog. Currently only supports the type for Google Cloud Storage Buckets. Possible values are: CATALOG_TYPE_GCS_BUCKET.
    create_time str
    Output only. The creation time of the IcebergCatalog.
    credential_mode str
    The credential mode used for the catalog. CREDENTIAL_MODE_END_USER - End user credentials, default. The authenticating user must have access to the catalog resources and the corresponding Google Cloud Storage files. CREDENTIAL_MODE_VENDED_CREDENTIALS - Use credential vending. The authenticating user must have access to the catalog resources and the system will provide the caller with downscoped credentials to access the Google Cloud Storage files. All table operations in this mode would require X-Iceberg-Access-Delegation header with vended-credentials value included. System will generate a service account and the catalog administrator must grant the service account appropriate permissions. Possible values are: CREDENTIAL_MODE_END_USER, CREDENTIAL_MODE_VENDED_CREDENTIALS.
    default_location str
    Output only. The default storage location for the catalog, e.g., gs://my-bucket.
    name str
    The name of the IcebergCatalog. Format: projects/{project_id_or_number}/catalogs/{iceberg_catalog_id}
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replicas Sequence[IcebergCatalogReplicaArgs]
    Output only. The replicas for the catalog metadata. Structure is documented below.
    storage_regions Sequence[str]
    Output only. The GCP region(s) where the physical metadata for the tables is stored, e.g. us-central1, nam4 or us. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.
    update_time str
    Output only. The last modification time of the IcebergCatalog.
    biglakeServiceAccount String
    Output only. The service account used for credential vending. It might be empty if credential vending was never enabled for the catalog.
    catalogType String
    The catalog type of the IcebergCatalog. Currently only supports the type for Google Cloud Storage Buckets. Possible values are: CATALOG_TYPE_GCS_BUCKET.
    createTime String
    Output only. The creation time of the IcebergCatalog.
    credentialMode String
    The credential mode used for the catalog. CREDENTIAL_MODE_END_USER - End user credentials, default. The authenticating user must have access to the catalog resources and the corresponding Google Cloud Storage files. CREDENTIAL_MODE_VENDED_CREDENTIALS - Use credential vending. The authenticating user must have access to the catalog resources and the system will provide the caller with downscoped credentials to access the Google Cloud Storage files. All table operations in this mode would require X-Iceberg-Access-Delegation header with vended-credentials value included. System will generate a service account and the catalog administrator must grant the service account appropriate permissions. Possible values are: CREDENTIAL_MODE_END_USER, CREDENTIAL_MODE_VENDED_CREDENTIALS.
    defaultLocation String
    Output only. The default storage location for the catalog, e.g., gs://my-bucket.
    name String
    The name of the IcebergCatalog. Format: projects/{project_id_or_number}/catalogs/{iceberg_catalog_id}
    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.
    storageRegions List<String>
    Output only. The GCP region(s) where the physical metadata for the tables is stored, e.g. us-central1, nam4 or us. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.
    updateTime String
    Output only. The last modification time of the IcebergCatalog.

    Supporting Types

    IcebergCatalogReplica, IcebergCatalogReplicaArgs

    Region string
    (Output) The region of the replica, e.g., us-east1.
    State string
    (Output) If the IcebergCatalog is replicated to multiple regions, this describes the current state of the replica. STATE_UNKNOWN - 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 namespaces 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 IcebergCatalog is replicated to multiple regions, this describes the current state of the replica. STATE_UNKNOWN - 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 namespaces 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 IcebergCatalog is replicated to multiple regions, this describes the current state of the replica. STATE_UNKNOWN - 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 namespaces 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 IcebergCatalog is replicated to multiple regions, this describes the current state of the replica. STATE_UNKNOWN - 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 namespaces 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 IcebergCatalog is replicated to multiple regions, this describes the current state of the replica. STATE_UNKNOWN - 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 namespaces 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 IcebergCatalog is replicated to multiple regions, this describes the current state of the replica. STATE_UNKNOWN - 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 namespaces are writeable yet. STATE_SECONDARY - The replica is a read-only secondary replica.

    Import

    IcebergCatalog can be imported using any of these accepted formats:

    • iceberg/v1/restcatalog/extensions/projects/{{project}}/catalogs/{{name}}

    • {{project}}/{{name}}

    • {{name}}

    When using the pulumi import command, IcebergCatalog can be imported using one of the formats above. For example:

    $ pulumi import gcp:biglake/icebergCatalog:IcebergCatalog default iceberg/v1/restcatalog/extensions/projects/{{project}}/catalogs/{{name}}
    
    $ pulumi import gcp:biglake/icebergCatalog:IcebergCatalog default {{project}}/{{name}}
    
    $ pulumi import gcp:biglake/icebergCatalog:IcebergCatalog 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
    Google Cloud v9.10.0 published on Friday, Jan 16, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate