1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. biglake
  5. IcebergNamespace
Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi
gcp logo
Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi

    IcebergNamespaces are containers for Apache Iceberg Tables within an IcebergCatalog.

    Example Usage

    Biglake Iceberg Namespace

    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.IcebergCatalog("catalog", {
        name: bucket.name,
        catalogType: "CATALOG_TYPE_GCS_BUCKET",
    });
    const myIcebergNamespace = new gcp.biglake.IcebergNamespace("my_iceberg_namespace", {
        catalog: catalog.name,
        namespaceId: "my_iceberg_namespace",
        properties: {
            key: "value",
        },
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    bucket = gcp.storage.Bucket("bucket",
        name="example-bucket",
        location="us-central1",
        force_destroy=True,
        uniform_bucket_level_access=True)
    catalog = gcp.biglake.IcebergCatalog("catalog",
        name=bucket.name,
        catalog_type="CATALOG_TYPE_GCS_BUCKET")
    my_iceberg_namespace = gcp.biglake.IcebergNamespace("my_iceberg_namespace",
        catalog=catalog.name,
        namespace_id="my_iceberg_namespace",
        properties={
            "key": "value",
        })
    
    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 {
    		bucket, err := storage.NewBucket(ctx, "bucket", &storage.BucketArgs{
    			Name:                     pulumi.String("example-bucket"),
    			Location:                 pulumi.String("us-central1"),
    			ForceDestroy:             pulumi.Bool(true),
    			UniformBucketLevelAccess: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		catalog, err := biglake.NewIcebergCatalog(ctx, "catalog", &biglake.IcebergCatalogArgs{
    			Name:        bucket.Name,
    			CatalogType: pulumi.String("CATALOG_TYPE_GCS_BUCKET"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = biglake.NewIcebergNamespace(ctx, "my_iceberg_namespace", &biglake.IcebergNamespaceArgs{
    			Catalog:     catalog.Name,
    			NamespaceId: pulumi.String("my_iceberg_namespace"),
    			Properties: pulumi.StringMap{
    				"key": pulumi.String("value"),
    			},
    		})
    		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 bucket = new Gcp.Storage.Bucket("bucket", new()
        {
            Name = "example-bucket",
            Location = "us-central1",
            ForceDestroy = true,
            UniformBucketLevelAccess = true,
        });
    
        var catalog = new Gcp.BigLake.IcebergCatalog("catalog", new()
        {
            Name = bucket.Name,
            CatalogType = "CATALOG_TYPE_GCS_BUCKET",
        });
    
        var myIcebergNamespace = new Gcp.BigLake.IcebergNamespace("my_iceberg_namespace", new()
        {
            Catalog = catalog.Name,
            NamespaceId = "my_iceberg_namespace",
            Properties = 
            {
                { "key", "value" },
            },
        });
    
    });
    
    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.gcp.biglake.IcebergNamespace;
    import com.pulumi.gcp.biglake.IcebergNamespaceArgs;
    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 bucket = new Bucket("bucket", BucketArgs.builder()
                .name("example-bucket")
                .location("us-central1")
                .forceDestroy(true)
                .uniformBucketLevelAccess(true)
                .build());
    
            var catalog = new IcebergCatalog("catalog", IcebergCatalogArgs.builder()
                .name(bucket.name())
                .catalogType("CATALOG_TYPE_GCS_BUCKET")
                .build());
    
            var myIcebergNamespace = new IcebergNamespace("myIcebergNamespace", IcebergNamespaceArgs.builder()
                .catalog(catalog.name())
                .namespaceId("my_iceberg_namespace")
                .properties(Map.of("key", "value"))
                .build());
    
        }
    }
    
    resources:
      bucket:
        type: gcp:storage:Bucket
        properties:
          name: example-bucket
          location: us-central1
          forceDestroy: true
          uniformBucketLevelAccess: true
      catalog:
        type: gcp:biglake:IcebergCatalog
        properties:
          name: ${bucket.name}
          catalogType: CATALOG_TYPE_GCS_BUCKET
      myIcebergNamespace:
        type: gcp:biglake:IcebergNamespace
        name: my_iceberg_namespace
        properties:
          catalog: ${catalog.name}
          namespaceId: my_iceberg_namespace
          properties:
            key: value
    

    Create IcebergNamespace Resource

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

    Constructor syntax

    new IcebergNamespace(name: string, args: IcebergNamespaceArgs, opts?: CustomResourceOptions);
    @overload
    def IcebergNamespace(resource_name: str,
                         args: IcebergNamespaceArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def IcebergNamespace(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         catalog: Optional[str] = None,
                         namespace_id: Optional[str] = None,
                         project: Optional[str] = None,
                         properties: Optional[Mapping[str, str]] = None)
    func NewIcebergNamespace(ctx *Context, name string, args IcebergNamespaceArgs, opts ...ResourceOption) (*IcebergNamespace, error)
    public IcebergNamespace(string name, IcebergNamespaceArgs args, CustomResourceOptions? opts = null)
    public IcebergNamespace(String name, IcebergNamespaceArgs args)
    public IcebergNamespace(String name, IcebergNamespaceArgs args, CustomResourceOptions options)
    
    type: gcp:biglake:IcebergNamespace
    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 IcebergNamespaceArgs
    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 IcebergNamespaceArgs
    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 IcebergNamespaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IcebergNamespaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IcebergNamespaceArgs
    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 icebergNamespaceResource = new Gcp.BigLake.IcebergNamespace("icebergNamespaceResource", new()
    {
        Catalog = "string",
        NamespaceId = "string",
        Project = "string",
        Properties = 
        {
            { "string", "string" },
        },
    });
    
    example, err := biglake.NewIcebergNamespace(ctx, "icebergNamespaceResource", &biglake.IcebergNamespaceArgs{
    	Catalog:     pulumi.String("string"),
    	NamespaceId: pulumi.String("string"),
    	Project:     pulumi.String("string"),
    	Properties: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var icebergNamespaceResource = new IcebergNamespace("icebergNamespaceResource", IcebergNamespaceArgs.builder()
        .catalog("string")
        .namespaceId("string")
        .project("string")
        .properties(Map.of("string", "string"))
        .build());
    
    iceberg_namespace_resource = gcp.biglake.IcebergNamespace("icebergNamespaceResource",
        catalog="string",
        namespace_id="string",
        project="string",
        properties={
            "string": "string",
        })
    
    const icebergNamespaceResource = new gcp.biglake.IcebergNamespace("icebergNamespaceResource", {
        catalog: "string",
        namespaceId: "string",
        project: "string",
        properties: {
            string: "string",
        },
    });
    
    type: gcp:biglake:IcebergNamespace
    properties:
        catalog: string
        namespaceId: string
        project: string
        properties:
            string: string
    

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

    Catalog string
    The name of the IcebergCatalog.
    NamespaceId string
    The unique identifier of the namespace.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Properties Dictionary<string, string>
    User-defined properties for the namespace.
    Catalog string
    The name of the IcebergCatalog.
    NamespaceId string
    The unique identifier of the namespace.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Properties map[string]string
    User-defined properties for the namespace.
    catalog String
    The name of the IcebergCatalog.
    namespaceId String
    The unique identifier of the namespace.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    properties Map<String,String>
    User-defined properties for the namespace.
    catalog string
    The name of the IcebergCatalog.
    namespaceId string
    The unique identifier of the namespace.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    properties {[key: string]: string}
    User-defined properties for the namespace.
    catalog str
    The name of the IcebergCatalog.
    namespace_id str
    The unique identifier of the namespace.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    properties Mapping[str, str]
    User-defined properties for the namespace.
    catalog String
    The name of the IcebergCatalog.
    namespaceId String
    The unique identifier of the namespace.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    properties Map<String>
    User-defined properties for the namespace.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IcebergNamespace Resource

    Get an existing IcebergNamespace 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?: IcebergNamespaceState, opts?: CustomResourceOptions): IcebergNamespace
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            catalog: Optional[str] = None,
            namespace_id: Optional[str] = None,
            project: Optional[str] = None,
            properties: Optional[Mapping[str, str]] = None) -> IcebergNamespace
    func GetIcebergNamespace(ctx *Context, name string, id IDInput, state *IcebergNamespaceState, opts ...ResourceOption) (*IcebergNamespace, error)
    public static IcebergNamespace Get(string name, Input<string> id, IcebergNamespaceState? state, CustomResourceOptions? opts = null)
    public static IcebergNamespace get(String name, Output<String> id, IcebergNamespaceState state, CustomResourceOptions options)
    resources:  _:    type: gcp:biglake:IcebergNamespace    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:
    Catalog string
    The name of the IcebergCatalog.
    NamespaceId string
    The unique identifier of the namespace.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Properties Dictionary<string, string>
    User-defined properties for the namespace.
    Catalog string
    The name of the IcebergCatalog.
    NamespaceId string
    The unique identifier of the namespace.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Properties map[string]string
    User-defined properties for the namespace.
    catalog String
    The name of the IcebergCatalog.
    namespaceId String
    The unique identifier of the namespace.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    properties Map<String,String>
    User-defined properties for the namespace.
    catalog string
    The name of the IcebergCatalog.
    namespaceId string
    The unique identifier of the namespace.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    properties {[key: string]: string}
    User-defined properties for the namespace.
    catalog str
    The name of the IcebergCatalog.
    namespace_id str
    The unique identifier of the namespace.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    properties Mapping[str, str]
    User-defined properties for the namespace.
    catalog String
    The name of the IcebergCatalog.
    namespaceId String
    The unique identifier of the namespace.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    properties Map<String>
    User-defined properties for the namespace.

    Import

    IcebergNamespace can be imported using any of these accepted formats:

    • projects/{{project}}/catalogs/{{catalog}}/namespaces/{{namespace_id}}
    • {{project}}/{{catalog}}/{{namespace_id}}
    • {{catalog}}/{{namespace_id}}

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

    $ pulumi import gcp:biglake/icebergNamespace:IcebergNamespace default projects/{{project}}/catalogs/{{catalog}}/namespaces/{{namespace_id}}
    $ pulumi import gcp:biglake/icebergNamespace:IcebergNamespace default {{project}}/{{catalog}}/{{namespace_id}}
    $ pulumi import gcp:biglake/icebergNamespace:IcebergNamespace default {{catalog}}/{{namespace_id}}
    

    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.15.0
    published on Thursday, Mar 12, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.