Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Snowflake Provider
  4. API Docs
  5. IcebergTableFromRest
Viewing docs for Snowflake v2.19.0
published on Friday, Jul 31, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-snowflake

snowflake.IcebergTableFromRest

snowflake logo
Viewing docs for Snowflake v2.19.0
published on Friday, Jul 31, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-snowflake

    Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to previewFeaturesEnabled field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.

    Note Due to Snowflake limitations, external changes to the external cloud storage type is not detected.

    Note External changes to pathLayout are not detected. This value is not read back from Snowflake during refresh. After import, the first pulumi preview may show a resource recreation for write-only non-alterable fields that are not reconciled with Snowflake. Run pulumi up once to sync these values into state.

    Resource used to manage an Iceberg table whose metadata is managed by an external Iceberg REST catalog. For more information, check the official documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";

// Basic - only required fields
const basic = new snowflake.IcebergTableFromRest("basic", {
    database: "DATABASE",
    schema: "SCHEMA",
    name: "TABLE",
    catalogTableName: "my_catalog_table",
});
// Complete - all fields set
const complete = new snowflake.IcebergTableFromRest("complete", {
    database: "DATABASE",
    schema: "SCHEMA",
    name: "TABLE",
    externalVolume: "EXTERNAL_VOLUME",
    catalog: "CATALOG",
    catalogTableName: "my_catalog_table",
    catalogNamespace: "my_namespace",
    pathLayout: "HIERARCHICAL",
    targetFileSize: "128MB",
    replaceInvalidCharacters: true,
    autoRefresh: "true",
    comment: "COMMENT",
    storageSerializationPolicy: "OPTIMIZED",
    icebergMergeOnReadBehavior: "ENABLED",
    enableIcebergMergeOnRead: true,
});

    import pulumi
import pulumi_snowflake as snowflake

# Basic - only required fields
basic = snowflake.IcebergTableFromRest("basic",
    database="DATABASE",
    schema="SCHEMA",
    name="TABLE",
    catalog_table_name="my_catalog_table")
# Complete - all fields set
complete = snowflake.IcebergTableFromRest("complete",
    database="DATABASE",
    schema="SCHEMA",
    name="TABLE",
    external_volume="EXTERNAL_VOLUME",
    catalog="CATALOG",
    catalog_table_name="my_catalog_table",
    catalog_namespace="my_namespace",
    path_layout="HIERARCHICAL",
    target_file_size="128MB",
    replace_invalid_characters=True,
    auto_refresh="true",
    comment="COMMENT",
    storage_serialization_policy="OPTIMIZED",
    iceberg_merge_on_read_behavior="ENABLED",
    enable_iceberg_merge_on_read=True)

    package main

import (
	"github.com/pulumi/pulumi-snowflake/sdk/v2/go/snowflake"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Basic - only required fields
		_, err := snowflake.NewIcebergTableFromRest(ctx, "basic", &snowflake.IcebergTableFromRestArgs{
			Database:         pulumi.String("DATABASE"),
			Schema:           pulumi.String("SCHEMA"),
			Name:             pulumi.String("TABLE"),
			CatalogTableName: pulumi.String("my_catalog_table"),
		})
		if err != nil {
			return err
		}
		// Complete - all fields set
		_, err = snowflake.NewIcebergTableFromRest(ctx, "complete", &snowflake.IcebergTableFromRestArgs{
			Database:                   pulumi.String("DATABASE"),
			Schema:                     pulumi.String("SCHEMA"),
			Name:                       pulumi.String("TABLE"),
			ExternalVolume:             pulumi.String("EXTERNAL_VOLUME"),
			Catalog:                    pulumi.String("CATALOG"),
			CatalogTableName:           pulumi.String("my_catalog_table"),
			CatalogNamespace:           pulumi.String("my_namespace"),
			PathLayout:                 pulumi.String("HIERARCHICAL"),
			TargetFileSize:             pulumi.String("128MB"),
			ReplaceInvalidCharacters:   pulumi.Bool(true),
			AutoRefresh:                pulumi.String("true"),
			Comment:                    pulumi.String("COMMENT"),
			StorageSerializationPolicy: pulumi.String("OPTIMIZED"),
			IcebergMergeOnReadBehavior: pulumi.String("ENABLED"),
			EnableIcebergMergeOnRead:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Basic - only required fields
    var basic = new Snowflake.IcebergTableFromRest("basic", new()
    {
        Database = "DATABASE",
        Schema = "SCHEMA",
        Name = "TABLE",
        CatalogTableName = "my_catalog_table",
    });

    // Complete - all fields set
    var complete = new Snowflake.IcebergTableFromRest("complete", new()
    {
        Database = "DATABASE",
        Schema = "SCHEMA",
        Name = "TABLE",
        ExternalVolume = "EXTERNAL_VOLUME",
        Catalog = "CATALOG",
        CatalogTableName = "my_catalog_table",
        CatalogNamespace = "my_namespace",
        PathLayout = "HIERARCHICAL",
        TargetFileSize = "128MB",
        ReplaceInvalidCharacters = true,
        AutoRefresh = "true",
        Comment = "COMMENT",
        StorageSerializationPolicy = "OPTIMIZED",
        IcebergMergeOnReadBehavior = "ENABLED",
        EnableIcebergMergeOnRead = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.IcebergTableFromRest;
import com.pulumi.snowflake.IcebergTableFromRestArgs;
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) {
        // Basic - only required fields
        var basic = new IcebergTableFromRest("basic", IcebergTableFromRestArgs.builder()
            .database("DATABASE")
            .schema("SCHEMA")
            .name("TABLE")
            .catalogTableName("my_catalog_table")
            .build());

        // Complete - all fields set
        var complete = new IcebergTableFromRest("complete", IcebergTableFromRestArgs.builder()
            .database("DATABASE")
            .schema("SCHEMA")
            .name("TABLE")
            .externalVolume("EXTERNAL_VOLUME")
            .catalog("CATALOG")
            .catalogTableName("my_catalog_table")
            .catalogNamespace("my_namespace")
            .pathLayout("HIERARCHICAL")
            .targetFileSize("128MB")
            .replaceInvalidCharacters(true)
            .autoRefresh("true")
            .comment("COMMENT")
            .storageSerializationPolicy("OPTIMIZED")
            .icebergMergeOnReadBehavior("ENABLED")
            .enableIcebergMergeOnRead(true)
            .build());

    }
}

    resources:
  # Basic - only required fields
  basic:
    type: snowflake:IcebergTableFromRest
    properties:
      database: DATABASE
      schema: SCHEMA
      name: TABLE
      catalogTableName: my_catalog_table
  # Complete - all fields set
  complete:
    type: snowflake:IcebergTableFromRest
    properties:
      database: DATABASE
      schema: SCHEMA
      name: TABLE
      externalVolume: EXTERNAL_VOLUME
      catalog: CATALOG
      catalogTableName: my_catalog_table
      catalogNamespace: my_namespace
      pathLayout: HIERARCHICAL
      targetFileSize: 128MB
      replaceInvalidCharacters: true
      autoRefresh: 'true'
      comment: COMMENT
      storageSerializationPolicy: OPTIMIZED
      icebergMergeOnReadBehavior: ENABLED
      enableIcebergMergeOnRead: true

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

# Basic - only required fields
resource "snowflake_icebergtablefromrest" "basic" {
  database           = "DATABASE"
  schema             = "SCHEMA"
  name               = "TABLE"
  catalog_table_name = "my_catalog_table"
}
# Complete - all fields set
resource "snowflake_icebergtablefromrest" "complete" {
  database                       = "DATABASE"
  schema                         = "SCHEMA"
  name                           = "TABLE"
  external_volume                = "EXTERNAL_VOLUME"
  catalog                        = "CATALOG"
  catalog_table_name             = "my_catalog_table"
  catalog_namespace              = "my_namespace"
  path_layout                    = "HIERARCHICAL"
  target_file_size               = "128MB"
  replace_invalid_characters     = true
  auto_refresh                   = "true"
  comment                        = "COMMENT"
  storage_serialization_policy   = "OPTIMIZED"
  iceberg_merge_on_read_behavior = "ENABLED"
  enable_iceberg_merge_on_read   = true
}

    Note Instead of using fully_qualified_name, you can reference objects managed outside Terraform by constructing a correct ID, consult identifiers guide.

    Note If a field has a default value, it is shown next to the type in the schema.

    Create IcebergTableFromRest Resource

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

    Constructor syntax

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

@overload
def IcebergTableFromRest(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         catalog_table_name: Optional[str] = None,
                         schema: Optional[str] = None,
                         database: Optional[str] = None,
                         enable_iceberg_merge_on_read: Optional[bool] = None,
                         comment: Optional[str] = None,
                         catalog_namespace: Optional[str] = None,
                         auto_refresh: Optional[str] = None,
                         external_volume: Optional[str] = None,
                         iceberg_merge_on_read_behavior: Optional[str] = None,
                         name: Optional[str] = None,
                         path_layout: Optional[str] = None,
                         replace_invalid_characters: Optional[bool] = None,
                         catalog: Optional[str] = None,
                         storage_serialization_policy: Optional[str] = None,
                         target_file_size: Optional[str] = None)
    func NewIcebergTableFromRest(ctx *Context, name string, args IcebergTableFromRestArgs, opts ...ResourceOption) (*IcebergTableFromRest, error)
    public IcebergTableFromRest(string name, IcebergTableFromRestArgs args, CustomResourceOptions? opts = null)
    public IcebergTableFromRest(String name, IcebergTableFromRestArgs args)
public IcebergTableFromRest(String name, IcebergTableFromRestArgs args, CustomResourceOptions options)

    type: snowflake:IcebergTableFromRest
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "snowflake_iceberg_table_from_rest" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args IcebergTableFromRestArgs
    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 IcebergTableFromRestArgs
    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 IcebergTableFromRestArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IcebergTableFromRestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IcebergTableFromRestArgs
    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 icebergTableFromRestResource = new Snowflake.IcebergTableFromRest("icebergTableFromRestResource", new()
{
    CatalogTableName = "string",
    Schema = "string",
    Database = "string",
    EnableIcebergMergeOnRead = false,
    Comment = "string",
    CatalogNamespace = "string",
    AutoRefresh = "string",
    ExternalVolume = "string",
    IcebergMergeOnReadBehavior = "string",
    Name = "string",
    PathLayout = "string",
    ReplaceInvalidCharacters = false,
    Catalog = "string",
    StorageSerializationPolicy = "string",
    TargetFileSize = "string",
});

    example, err := snowflake.NewIcebergTableFromRest(ctx, "icebergTableFromRestResource", &snowflake.IcebergTableFromRestArgs{
	CatalogTableName:           pulumi.String("string"),
	Schema:                     pulumi.String("string"),
	Database:                   pulumi.String("string"),
	EnableIcebergMergeOnRead:   pulumi.Bool(false),
	Comment:                    pulumi.String("string"),
	CatalogNamespace:           pulumi.String("string"),
	AutoRefresh:                pulumi.String("string"),
	ExternalVolume:             pulumi.String("string"),
	IcebergMergeOnReadBehavior: pulumi.String("string"),
	Name:                       pulumi.String("string"),
	PathLayout:                 pulumi.String("string"),
	ReplaceInvalidCharacters:   pulumi.Bool(false),
	Catalog:                    pulumi.String("string"),
	StorageSerializationPolicy: pulumi.String("string"),
	TargetFileSize:             pulumi.String("string"),
})

    resource "snowflake_iceberg_table_from_rest" "icebergTableFromRestResource" {
  lifecycle {
    create_before_destroy = true
  }
  catalog_table_name             = "string"
  schema                         = "string"
  database                       = "string"
  enable_iceberg_merge_on_read   = false
  comment                        = "string"
  catalog_namespace              = "string"
  auto_refresh                   = "string"
  external_volume                = "string"
  iceberg_merge_on_read_behavior = "string"
  name                           = "string"
  path_layout                    = "string"
  replace_invalid_characters     = false
  catalog                        = "string"
  storage_serialization_policy   = "string"
  target_file_size               = "string"
}

    var icebergTableFromRestResource = new IcebergTableFromRest("icebergTableFromRestResource", IcebergTableFromRestArgs.builder()
    .catalogTableName("string")
    .schema("string")
    .database("string")
    .enableIcebergMergeOnRead(false)
    .comment("string")
    .catalogNamespace("string")
    .autoRefresh("string")
    .externalVolume("string")
    .icebergMergeOnReadBehavior("string")
    .name("string")
    .pathLayout("string")
    .replaceInvalidCharacters(false)
    .catalog("string")
    .storageSerializationPolicy("string")
    .targetFileSize("string")
    .build());

    iceberg_table_from_rest_resource = snowflake.IcebergTableFromRest("icebergTableFromRestResource",
    catalog_table_name="string",
    schema="string",
    database="string",
    enable_iceberg_merge_on_read=False,
    comment="string",
    catalog_namespace="string",
    auto_refresh="string",
    external_volume="string",
    iceberg_merge_on_read_behavior="string",
    name="string",
    path_layout="string",
    replace_invalid_characters=False,
    catalog="string",
    storage_serialization_policy="string",
    target_file_size="string")

    const icebergTableFromRestResource = new snowflake.IcebergTableFromRest("icebergTableFromRestResource", {
    catalogTableName: "string",
    schema: "string",
    database: "string",
    enableIcebergMergeOnRead: false,
    comment: "string",
    catalogNamespace: "string",
    autoRefresh: "string",
    externalVolume: "string",
    icebergMergeOnReadBehavior: "string",
    name: "string",
    pathLayout: "string",
    replaceInvalidCharacters: false,
    catalog: "string",
    storageSerializationPolicy: "string",
    targetFileSize: "string",
});

    type: snowflake:IcebergTableFromRest
properties:
    autoRefresh: string
    catalog: string
    catalogNamespace: string
    catalogTableName: string
    comment: string
    database: string
    enableIcebergMergeOnRead: false
    externalVolume: string
    icebergMergeOnReadBehavior: string
    name: string
    pathLayout: string
    replaceInvalidCharacters: false
    schema: string
    storageSerializationPolicy: string
    targetFileSize: string

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

    CatalogTableName string
    Specifies the name of the table as it appears in the external catalog.
    Database string
    The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Schema string
    The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    AutoRefresh string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether Snowflake should periodically refresh the Iceberg table metadata from the external catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    Catalog string
    Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
    CatalogNamespace string
    Specifies the namespace (or database) in the external catalog that the table belongs to. If not specified, the catalog integration's default namespace is used.
    Comment string
    Specifies a comment for the Iceberg table.
    EnableIcebergMergeOnRead bool
    Specifies whether merge-on-read is enabled for the Iceberg table. For more information, check ENABLEICEBERGMERGEONREAD docs.
    ExternalVolume string
    Specifies the identifier for the external volume where the Iceberg table stores its metadata files and data in Parquet format. If not specified, the account-level default is used.
    IcebergMergeOnReadBehavior string
    Specifies the merge-on-read behavior for the Iceberg table. Valid values are: [AUTO ENABLED DISABLED]. Cannot be changed after creation. For more information, check ICEBERGMERGEONREADBEHAVIOR docs.
    Name string
    Specifies the identifier for the Iceberg table; must be unique for the schema in which the Iceberg table is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    PathLayout string
    Specifies the storage layout for the Iceberg table's Parquet files. Valid values are: [FLAT HIERARCHICAL]. Cannot be changed after creation. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    ReplaceInvalidCharacters bool
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. For more information, check REPLACEINVALIDCHARACTERS docs.
    StorageSerializationPolicy string
    Specifies the storage serialization policy for the Iceberg table. Valid values are: [COMPATIBLE OPTIMIZED]. Cannot be changed after creation. For more information, check STORAGESERIALIZATIONPOLICY docs.
    TargetFileSize string
    Specifies the target file size (in bytes) used when writing the Iceberg table's Parquet files. Valid values are: [AUTO 16MB 32MB 64MB 128MB]. For more information, check TARGETFILESIZE docs.
    CatalogTableName string
    Specifies the name of the table as it appears in the external catalog.
    Database string
    The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Schema string
    The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    AutoRefresh string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether Snowflake should periodically refresh the Iceberg table metadata from the external catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    Catalog string
    Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
    CatalogNamespace string
    Specifies the namespace (or database) in the external catalog that the table belongs to. If not specified, the catalog integration's default namespace is used.
    Comment string
    Specifies a comment for the Iceberg table.
    EnableIcebergMergeOnRead bool
    Specifies whether merge-on-read is enabled for the Iceberg table. For more information, check ENABLEICEBERGMERGEONREAD docs.
    ExternalVolume string
    Specifies the identifier for the external volume where the Iceberg table stores its metadata files and data in Parquet format. If not specified, the account-level default is used.
    IcebergMergeOnReadBehavior string
    Specifies the merge-on-read behavior for the Iceberg table. Valid values are: [AUTO ENABLED DISABLED]. Cannot be changed after creation. For more information, check ICEBERGMERGEONREADBEHAVIOR docs.
    Name string
    Specifies the identifier for the Iceberg table; must be unique for the schema in which the Iceberg table is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    PathLayout string
    Specifies the storage layout for the Iceberg table's Parquet files. Valid values are: [FLAT HIERARCHICAL]. Cannot be changed after creation. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    ReplaceInvalidCharacters bool
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. For more information, check REPLACEINVALIDCHARACTERS docs.
    StorageSerializationPolicy string
    Specifies the storage serialization policy for the Iceberg table. Valid values are: [COMPATIBLE OPTIMIZED]. Cannot be changed after creation. For more information, check STORAGESERIALIZATIONPOLICY docs.
    TargetFileSize string
    Specifies the target file size (in bytes) used when writing the Iceberg table's Parquet files. Valid values are: [AUTO 16MB 32MB 64MB 128MB]. For more information, check TARGETFILESIZE docs.
    catalog_table_name string
    Specifies the name of the table as it appears in the external catalog.
    database string
    The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema string
    The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    auto_refresh string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether Snowflake should periodically refresh the Iceberg table metadata from the external catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    catalog string
    Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
    catalog_namespace string
    Specifies the namespace (or database) in the external catalog that the table belongs to. If not specified, the catalog integration's default namespace is used.
    comment string
    Specifies a comment for the Iceberg table.
    enable_iceberg_merge_on_read bool
    Specifies whether merge-on-read is enabled for the Iceberg table. For more information, check ENABLEICEBERGMERGEONREAD docs.
    external_volume string
    Specifies the identifier for the external volume where the Iceberg table stores its metadata files and data in Parquet format. If not specified, the account-level default is used.
    iceberg_merge_on_read_behavior string
    Specifies the merge-on-read behavior for the Iceberg table. Valid values are: [AUTO ENABLED DISABLED]. Cannot be changed after creation. For more information, check ICEBERGMERGEONREADBEHAVIOR docs.
    name string
    Specifies the identifier for the Iceberg table; must be unique for the schema in which the Iceberg table is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    path_layout string
    Specifies the storage layout for the Iceberg table's Parquet files. Valid values are: [FLAT HIERARCHICAL]. Cannot be changed after creation. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    replace_invalid_characters bool
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. For more information, check REPLACEINVALIDCHARACTERS docs.
    storage_serialization_policy string
    Specifies the storage serialization policy for the Iceberg table. Valid values are: [COMPATIBLE OPTIMIZED]. Cannot be changed after creation. For more information, check STORAGESERIALIZATIONPOLICY docs.
    target_file_size string
    Specifies the target file size (in bytes) used when writing the Iceberg table's Parquet files. Valid values are: [AUTO 16MB 32MB 64MB 128MB]. For more information, check TARGETFILESIZE docs.
    catalogTableName String
    Specifies the name of the table as it appears in the external catalog.
    database String
    The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema String
    The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    autoRefresh String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether Snowflake should periodically refresh the Iceberg table metadata from the external catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    catalog String
    Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
    catalogNamespace String
    Specifies the namespace (or database) in the external catalog that the table belongs to. If not specified, the catalog integration's default namespace is used.
    comment String
    Specifies a comment for the Iceberg table.
    enableIcebergMergeOnRead Boolean
    Specifies whether merge-on-read is enabled for the Iceberg table. For more information, check ENABLEICEBERGMERGEONREAD docs.
    externalVolume String
    Specifies the identifier for the external volume where the Iceberg table stores its metadata files and data in Parquet format. If not specified, the account-level default is used.
    icebergMergeOnReadBehavior String
    Specifies the merge-on-read behavior for the Iceberg table. Valid values are: [AUTO ENABLED DISABLED]. Cannot be changed after creation. For more information, check ICEBERGMERGEONREADBEHAVIOR docs.
    name String
    Specifies the identifier for the Iceberg table; must be unique for the schema in which the Iceberg table is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    pathLayout String
    Specifies the storage layout for the Iceberg table's Parquet files. Valid values are: [FLAT HIERARCHICAL]. Cannot be changed after creation. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    replaceInvalidCharacters Boolean
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. For more information, check REPLACEINVALIDCHARACTERS docs.
    storageSerializationPolicy String
    Specifies the storage serialization policy for the Iceberg table. Valid values are: [COMPATIBLE OPTIMIZED]. Cannot be changed after creation. For more information, check STORAGESERIALIZATIONPOLICY docs.
    targetFileSize String
    Specifies the target file size (in bytes) used when writing the Iceberg table's Parquet files. Valid values are: [AUTO 16MB 32MB 64MB 128MB]. For more information, check TARGETFILESIZE docs.
    catalogTableName string
    Specifies the name of the table as it appears in the external catalog.
    database string
    The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema string
    The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    autoRefresh string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether Snowflake should periodically refresh the Iceberg table metadata from the external catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    catalog string
    Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
    catalogNamespace string
    Specifies the namespace (or database) in the external catalog that the table belongs to. If not specified, the catalog integration's default namespace is used.
    comment string
    Specifies a comment for the Iceberg table.
    enableIcebergMergeOnRead boolean
    Specifies whether merge-on-read is enabled for the Iceberg table. For more information, check ENABLEICEBERGMERGEONREAD docs.
    externalVolume string
    Specifies the identifier for the external volume where the Iceberg table stores its metadata files and data in Parquet format. If not specified, the account-level default is used.
    icebergMergeOnReadBehavior string
    Specifies the merge-on-read behavior for the Iceberg table. Valid values are: [AUTO ENABLED DISABLED]. Cannot be changed after creation. For more information, check ICEBERGMERGEONREADBEHAVIOR docs.
    name string
    Specifies the identifier for the Iceberg table; must be unique for the schema in which the Iceberg table is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    pathLayout string
    Specifies the storage layout for the Iceberg table's Parquet files. Valid values are: [FLAT HIERARCHICAL]. Cannot be changed after creation. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    replaceInvalidCharacters boolean
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. For more information, check REPLACEINVALIDCHARACTERS docs.
    storageSerializationPolicy string
    Specifies the storage serialization policy for the Iceberg table. Valid values are: [COMPATIBLE OPTIMIZED]. Cannot be changed after creation. For more information, check STORAGESERIALIZATIONPOLICY docs.
    targetFileSize string
    Specifies the target file size (in bytes) used when writing the Iceberg table's Parquet files. Valid values are: [AUTO 16MB 32MB 64MB 128MB]. For more information, check TARGETFILESIZE docs.
    catalog_table_name str
    Specifies the name of the table as it appears in the external catalog.
    database str
    The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema str
    The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    auto_refresh str
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether Snowflake should periodically refresh the Iceberg table metadata from the external catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    catalog str
    Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
    catalog_namespace str
    Specifies the namespace (or database) in the external catalog that the table belongs to. If not specified, the catalog integration's default namespace is used.
    comment str
    Specifies a comment for the Iceberg table.
    enable_iceberg_merge_on_read bool
    Specifies whether merge-on-read is enabled for the Iceberg table. For more information, check ENABLEICEBERGMERGEONREAD docs.
    external_volume str
    Specifies the identifier for the external volume where the Iceberg table stores its metadata files and data in Parquet format. If not specified, the account-level default is used.
    iceberg_merge_on_read_behavior str
    Specifies the merge-on-read behavior for the Iceberg table. Valid values are: [AUTO ENABLED DISABLED]. Cannot be changed after creation. For more information, check ICEBERGMERGEONREADBEHAVIOR docs.
    name str
    Specifies the identifier for the Iceberg table; must be unique for the schema in which the Iceberg table is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    path_layout str
    Specifies the storage layout for the Iceberg table's Parquet files. Valid values are: [FLAT HIERARCHICAL]. Cannot be changed after creation. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    replace_invalid_characters bool
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. For more information, check REPLACEINVALIDCHARACTERS docs.
    storage_serialization_policy str
    Specifies the storage serialization policy for the Iceberg table. Valid values are: [COMPATIBLE OPTIMIZED]. Cannot be changed after creation. For more information, check STORAGESERIALIZATIONPOLICY docs.
    target_file_size str
    Specifies the target file size (in bytes) used when writing the Iceberg table's Parquet files. Valid values are: [AUTO 16MB 32MB 64MB 128MB]. For more information, check TARGETFILESIZE docs.
    catalogTableName String
    Specifies the name of the table as it appears in the external catalog.
    database String
    The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema String
    The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    autoRefresh String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether Snowflake should periodically refresh the Iceberg table metadata from the external catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    catalog String
    Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
    catalogNamespace String
    Specifies the namespace (or database) in the external catalog that the table belongs to. If not specified, the catalog integration's default namespace is used.
    comment String
    Specifies a comment for the Iceberg table.
    enableIcebergMergeOnRead Boolean
    Specifies whether merge-on-read is enabled for the Iceberg table. For more information, check ENABLEICEBERGMERGEONREAD docs.
    externalVolume String
    Specifies the identifier for the external volume where the Iceberg table stores its metadata files and data in Parquet format. If not specified, the account-level default is used.
    icebergMergeOnReadBehavior String
    Specifies the merge-on-read behavior for the Iceberg table. Valid values are: [AUTO ENABLED DISABLED]. Cannot be changed after creation. For more information, check ICEBERGMERGEONREADBEHAVIOR docs.
    name String
    Specifies the identifier for the Iceberg table; must be unique for the schema in which the Iceberg table is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    pathLayout String
    Specifies the storage layout for the Iceberg table's Parquet files. Valid values are: [FLAT HIERARCHICAL]. Cannot be changed after creation. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    replaceInvalidCharacters Boolean
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. For more information, check REPLACEINVALIDCHARACTERS docs.
    storageSerializationPolicy String
    Specifies the storage serialization policy for the Iceberg table. Valid values are: [COMPATIBLE OPTIMIZED]. Cannot be changed after creation. For more information, check STORAGESERIALIZATIONPOLICY docs.
    targetFileSize String
    Specifies the target file size (in bytes) used when writing the Iceberg table's Parquet files. Valid values are: [AUTO 16MB 32MB 64MB 128MB]. For more information, check TARGETFILESIZE docs.

    Outputs

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

    DescribeOutputs List<IcebergTableFromRestDescribeOutput>
    Outputs the result of DESCRIBE ICEBERG TABLE for the given Iceberg table.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    Parameters List<IcebergTableFromRestParameter>
    Outputs the result of SHOW PARAMETERS IN ICEBERG TABLE for the given Iceberg table.
    ShowOutputs List<IcebergTableFromRestShowOutput>
    Outputs the result of SHOW ICEBERG TABLES for the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
    DescribeOutputs []IcebergTableFromRestDescribeOutput
    Outputs the result of DESCRIBE ICEBERG TABLE for the given Iceberg table.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    Parameters []IcebergTableFromRestParameter
    Outputs the result of SHOW PARAMETERS IN ICEBERG TABLE for the given Iceberg table.
    ShowOutputs []IcebergTableFromRestShowOutput
    Outputs the result of SHOW ICEBERG TABLES for the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
    describe_outputs list(object)
    Outputs the result of DESCRIBE ICEBERG TABLE for the given Iceberg table.
    fully_qualified_name string
    Fully qualified name of the resource. For more information, see object name resolution.
    id string
    The provider-assigned unique ID for this managed resource.
    parameters list(object)
    Outputs the result of SHOW PARAMETERS IN ICEBERG TABLE for the given Iceberg table.
    show_outputs list(object)
    Outputs the result of SHOW ICEBERG TABLES for the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
    describeOutputs List<IcebergTableFromRestDescribeOutput>
    Outputs the result of DESCRIBE ICEBERG TABLE for the given Iceberg table.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    parameters List<IcebergTableFromRestParameter>
    Outputs the result of SHOW PARAMETERS IN ICEBERG TABLE for the given Iceberg table.
    showOutputs List<IcebergTableFromRestShowOutput>
    Outputs the result of SHOW ICEBERG TABLES for the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
    describeOutputs IcebergTableFromRestDescribeOutput[]
    Outputs the result of DESCRIBE ICEBERG TABLE for the given Iceberg table.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    id string
    The provider-assigned unique ID for this managed resource.
    parameters IcebergTableFromRestParameter[]
    Outputs the result of SHOW PARAMETERS IN ICEBERG TABLE for the given Iceberg table.
    showOutputs IcebergTableFromRestShowOutput[]
    Outputs the result of SHOW ICEBERG TABLES for the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
    describe_outputs Sequence[IcebergTableFromRestDescribeOutput]
    Outputs the result of DESCRIBE ICEBERG TABLE for the given Iceberg table.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    id str
    The provider-assigned unique ID for this managed resource.
    parameters Sequence[IcebergTableFromRestParameter]
    Outputs the result of SHOW PARAMETERS IN ICEBERG TABLE for the given Iceberg table.
    show_outputs Sequence[IcebergTableFromRestShowOutput]
    Outputs the result of SHOW ICEBERG TABLES for the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE ICEBERG TABLE for the given Iceberg table.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    parameters List<Property Map>
    Outputs the result of SHOW PARAMETERS IN ICEBERG TABLE for the given Iceberg table.
    showOutputs List<Property Map>
    Outputs the result of SHOW ICEBERG TABLES for the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.

    Look up Existing IcebergTableFromRest Resource

    Get an existing IcebergTableFromRest 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?: IcebergTableFromRestState, opts?: CustomResourceOptions): IcebergTableFromRest
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_refresh: Optional[str] = None,
        catalog: Optional[str] = None,
        catalog_namespace: Optional[str] = None,
        catalog_table_name: Optional[str] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        describe_outputs: Optional[Sequence[IcebergTableFromRestDescribeOutputArgs]] = None,
        enable_iceberg_merge_on_read: Optional[bool] = None,
        external_volume: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        iceberg_merge_on_read_behavior: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Sequence[IcebergTableFromRestParameterArgs]] = None,
        path_layout: Optional[str] = None,
        replace_invalid_characters: Optional[bool] = None,
        schema: Optional[str] = None,
        show_outputs: Optional[Sequence[IcebergTableFromRestShowOutputArgs]] = None,
        storage_serialization_policy: Optional[str] = None,
        target_file_size: Optional[str] = None) -> IcebergTableFromRest
    func GetIcebergTableFromRest(ctx *Context, name string, id IDInput, state *IcebergTableFromRestState, opts ...ResourceOption) (*IcebergTableFromRest, error)
    public static IcebergTableFromRest Get(string name, Input<string> id, IcebergTableFromRestState? state, CustomResourceOptions? opts = null)
    public static IcebergTableFromRest get(String name, Output<String> id, IcebergTableFromRestState state, CustomResourceOptions options)
    resources:  _:    type: snowflake:IcebergTableFromRest    get:      id: ${id}
    import {
  to = snowflake_iceberg_table_from_rest.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:
    AutoRefresh string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether Snowflake should periodically refresh the Iceberg table metadata from the external catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    Catalog string
    Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
    CatalogNamespace string
    Specifies the namespace (or database) in the external catalog that the table belongs to. If not specified, the catalog integration's default namespace is used.
    CatalogTableName string
    Specifies the name of the table as it appears in the external catalog.
    Comment string
    Specifies a comment for the Iceberg table.
    Database string
    The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    DescribeOutputs List<IcebergTableFromRestDescribeOutput>
    Outputs the result of DESCRIBE ICEBERG TABLE for the given Iceberg table.
    EnableIcebergMergeOnRead bool
    Specifies whether merge-on-read is enabled for the Iceberg table. For more information, check ENABLEICEBERGMERGEONREAD docs.
    ExternalVolume string
    Specifies the identifier for the external volume where the Iceberg table stores its metadata files and data in Parquet format. If not specified, the account-level default is used.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    IcebergMergeOnReadBehavior string
    Specifies the merge-on-read behavior for the Iceberg table. Valid values are: [AUTO ENABLED DISABLED]. Cannot be changed after creation. For more information, check ICEBERGMERGEONREADBEHAVIOR docs.
    Name string
    Specifies the identifier for the Iceberg table; must be unique for the schema in which the Iceberg table is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Parameters List<IcebergTableFromRestParameter>
    Outputs the result of SHOW PARAMETERS IN ICEBERG TABLE for the given Iceberg table.
    PathLayout string
    Specifies the storage layout for the Iceberg table's Parquet files. Valid values are: [FLAT HIERARCHICAL]. Cannot be changed after creation. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    ReplaceInvalidCharacters bool
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. For more information, check REPLACEINVALIDCHARACTERS docs.
    Schema string
    The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ShowOutputs List<IcebergTableFromRestShowOutput>
    Outputs the result of SHOW ICEBERG TABLES for the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
    StorageSerializationPolicy string
    Specifies the storage serialization policy for the Iceberg table. Valid values are: [COMPATIBLE OPTIMIZED]. Cannot be changed after creation. For more information, check STORAGESERIALIZATIONPOLICY docs.
    TargetFileSize string
    Specifies the target file size (in bytes) used when writing the Iceberg table's Parquet files. Valid values are: [AUTO 16MB 32MB 64MB 128MB]. For more information, check TARGETFILESIZE docs.
    AutoRefresh string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether Snowflake should periodically refresh the Iceberg table metadata from the external catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    Catalog string
    Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
    CatalogNamespace string
    Specifies the namespace (or database) in the external catalog that the table belongs to. If not specified, the catalog integration's default namespace is used.
    CatalogTableName string
    Specifies the name of the table as it appears in the external catalog.
    Comment string
    Specifies a comment for the Iceberg table.
    Database string
    The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    DescribeOutputs []IcebergTableFromRestDescribeOutputArgs
    Outputs the result of DESCRIBE ICEBERG TABLE for the given Iceberg table.
    EnableIcebergMergeOnRead bool
    Specifies whether merge-on-read is enabled for the Iceberg table. For more information, check ENABLEICEBERGMERGEONREAD docs.
    ExternalVolume string
    Specifies the identifier for the external volume where the Iceberg table stores its metadata files and data in Parquet format. If not specified, the account-level default is used.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    IcebergMergeOnReadBehavior string
    Specifies the merge-on-read behavior for the Iceberg table. Valid values are: [AUTO ENABLED DISABLED]. Cannot be changed after creation. For more information, check ICEBERGMERGEONREADBEHAVIOR docs.
    Name string
    Specifies the identifier for the Iceberg table; must be unique for the schema in which the Iceberg table is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Parameters []IcebergTableFromRestParameterArgs
    Outputs the result of SHOW PARAMETERS IN ICEBERG TABLE for the given Iceberg table.
    PathLayout string
    Specifies the storage layout for the Iceberg table's Parquet files. Valid values are: [FLAT HIERARCHICAL]. Cannot be changed after creation. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    ReplaceInvalidCharacters bool
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. For more information, check REPLACEINVALIDCHARACTERS docs.
    Schema string
    The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ShowOutputs []IcebergTableFromRestShowOutputArgs
    Outputs the result of SHOW ICEBERG TABLES for the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
    StorageSerializationPolicy string
    Specifies the storage serialization policy for the Iceberg table. Valid values are: [COMPATIBLE OPTIMIZED]. Cannot be changed after creation. For more information, check STORAGESERIALIZATIONPOLICY docs.
    TargetFileSize string
    Specifies the target file size (in bytes) used when writing the Iceberg table's Parquet files. Valid values are: [AUTO 16MB 32MB 64MB 128MB]. For more information, check TARGETFILESIZE docs.
    auto_refresh string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether Snowflake should periodically refresh the Iceberg table metadata from the external catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    catalog string
    Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
    catalog_namespace string
    Specifies the namespace (or database) in the external catalog that the table belongs to. If not specified, the catalog integration's default namespace is used.
    catalog_table_name string
    Specifies the name of the table as it appears in the external catalog.
    comment string
    Specifies a comment for the Iceberg table.
    database string
    The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describe_outputs list(object)
    Outputs the result of DESCRIBE ICEBERG TABLE for the given Iceberg table.
    enable_iceberg_merge_on_read bool
    Specifies whether merge-on-read is enabled for the Iceberg table. For more information, check ENABLEICEBERGMERGEONREAD docs.
    external_volume string
    Specifies the identifier for the external volume where the Iceberg table stores its metadata files and data in Parquet format. If not specified, the account-level default is used.
    fully_qualified_name string
    Fully qualified name of the resource. For more information, see object name resolution.
    iceberg_merge_on_read_behavior string
    Specifies the merge-on-read behavior for the Iceberg table. Valid values are: [AUTO ENABLED DISABLED]. Cannot be changed after creation. For more information, check ICEBERGMERGEONREADBEHAVIOR docs.
    name string
    Specifies the identifier for the Iceberg table; must be unique for the schema in which the Iceberg table is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    parameters list(object)
    Outputs the result of SHOW PARAMETERS IN ICEBERG TABLE for the given Iceberg table.
    path_layout string
    Specifies the storage layout for the Iceberg table's Parquet files. Valid values are: [FLAT HIERARCHICAL]. Cannot be changed after creation. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    replace_invalid_characters bool
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. For more information, check REPLACEINVALIDCHARACTERS docs.
    schema string
    The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    show_outputs list(object)
    Outputs the result of SHOW ICEBERG TABLES for the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
    storage_serialization_policy string
    Specifies the storage serialization policy for the Iceberg table. Valid values are: [COMPATIBLE OPTIMIZED]. Cannot be changed after creation. For more information, check STORAGESERIALIZATIONPOLICY docs.
    target_file_size string
    Specifies the target file size (in bytes) used when writing the Iceberg table's Parquet files. Valid values are: [AUTO 16MB 32MB 64MB 128MB]. For more information, check TARGETFILESIZE docs.
    autoRefresh String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether Snowflake should periodically refresh the Iceberg table metadata from the external catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    catalog String
    Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
    catalogNamespace String
    Specifies the namespace (or database) in the external catalog that the table belongs to. If not specified, the catalog integration's default namespace is used.
    catalogTableName String
    Specifies the name of the table as it appears in the external catalog.
    comment String
    Specifies a comment for the Iceberg table.
    database String
    The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describeOutputs List<IcebergTableFromRestDescribeOutput>
    Outputs the result of DESCRIBE ICEBERG TABLE for the given Iceberg table.
    enableIcebergMergeOnRead Boolean
    Specifies whether merge-on-read is enabled for the Iceberg table. For more information, check ENABLEICEBERGMERGEONREAD docs.
    externalVolume String
    Specifies the identifier for the external volume where the Iceberg table stores its metadata files and data in Parquet format. If not specified, the account-level default is used.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    icebergMergeOnReadBehavior String
    Specifies the merge-on-read behavior for the Iceberg table. Valid values are: [AUTO ENABLED DISABLED]. Cannot be changed after creation. For more information, check ICEBERGMERGEONREADBEHAVIOR docs.
    name String
    Specifies the identifier for the Iceberg table; must be unique for the schema in which the Iceberg table is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    parameters List<IcebergTableFromRestParameter>
    Outputs the result of SHOW PARAMETERS IN ICEBERG TABLE for the given Iceberg table.
    pathLayout String
    Specifies the storage layout for the Iceberg table's Parquet files. Valid values are: [FLAT HIERARCHICAL]. Cannot be changed after creation. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    replaceInvalidCharacters Boolean
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. For more information, check REPLACEINVALIDCHARACTERS docs.
    schema String
    The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs List<IcebergTableFromRestShowOutput>
    Outputs the result of SHOW ICEBERG TABLES for the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
    storageSerializationPolicy String
    Specifies the storage serialization policy for the Iceberg table. Valid values are: [COMPATIBLE OPTIMIZED]. Cannot be changed after creation. For more information, check STORAGESERIALIZATIONPOLICY docs.
    targetFileSize String
    Specifies the target file size (in bytes) used when writing the Iceberg table's Parquet files. Valid values are: [AUTO 16MB 32MB 64MB 128MB]. For more information, check TARGETFILESIZE docs.
    autoRefresh string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether Snowflake should periodically refresh the Iceberg table metadata from the external catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    catalog string
    Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
    catalogNamespace string
    Specifies the namespace (or database) in the external catalog that the table belongs to. If not specified, the catalog integration's default namespace is used.
    catalogTableName string
    Specifies the name of the table as it appears in the external catalog.
    comment string
    Specifies a comment for the Iceberg table.
    database string
    The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describeOutputs IcebergTableFromRestDescribeOutput[]
    Outputs the result of DESCRIBE ICEBERG TABLE for the given Iceberg table.
    enableIcebergMergeOnRead boolean
    Specifies whether merge-on-read is enabled for the Iceberg table. For more information, check ENABLEICEBERGMERGEONREAD docs.
    externalVolume string
    Specifies the identifier for the external volume where the Iceberg table stores its metadata files and data in Parquet format. If not specified, the account-level default is used.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    icebergMergeOnReadBehavior string
    Specifies the merge-on-read behavior for the Iceberg table. Valid values are: [AUTO ENABLED DISABLED]. Cannot be changed after creation. For more information, check ICEBERGMERGEONREADBEHAVIOR docs.
    name string
    Specifies the identifier for the Iceberg table; must be unique for the schema in which the Iceberg table is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    parameters IcebergTableFromRestParameter[]
    Outputs the result of SHOW PARAMETERS IN ICEBERG TABLE for the given Iceberg table.
    pathLayout string
    Specifies the storage layout for the Iceberg table's Parquet files. Valid values are: [FLAT HIERARCHICAL]. Cannot be changed after creation. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    replaceInvalidCharacters boolean
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. For more information, check REPLACEINVALIDCHARACTERS docs.
    schema string
    The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs IcebergTableFromRestShowOutput[]
    Outputs the result of SHOW ICEBERG TABLES for the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
    storageSerializationPolicy string
    Specifies the storage serialization policy for the Iceberg table. Valid values are: [COMPATIBLE OPTIMIZED]. Cannot be changed after creation. For more information, check STORAGESERIALIZATIONPOLICY docs.
    targetFileSize string
    Specifies the target file size (in bytes) used when writing the Iceberg table's Parquet files. Valid values are: [AUTO 16MB 32MB 64MB 128MB]. For more information, check TARGETFILESIZE docs.
    auto_refresh str
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether Snowflake should periodically refresh the Iceberg table metadata from the external catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    catalog str
    Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
    catalog_namespace str
    Specifies the namespace (or database) in the external catalog that the table belongs to. If not specified, the catalog integration's default namespace is used.
    catalog_table_name str
    Specifies the name of the table as it appears in the external catalog.
    comment str
    Specifies a comment for the Iceberg table.
    database str
    The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describe_outputs Sequence[IcebergTableFromRestDescribeOutputArgs]
    Outputs the result of DESCRIBE ICEBERG TABLE for the given Iceberg table.
    enable_iceberg_merge_on_read bool
    Specifies whether merge-on-read is enabled for the Iceberg table. For more information, check ENABLEICEBERGMERGEONREAD docs.
    external_volume str
    Specifies the identifier for the external volume where the Iceberg table stores its metadata files and data in Parquet format. If not specified, the account-level default is used.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    iceberg_merge_on_read_behavior str
    Specifies the merge-on-read behavior for the Iceberg table. Valid values are: [AUTO ENABLED DISABLED]. Cannot be changed after creation. For more information, check ICEBERGMERGEONREADBEHAVIOR docs.
    name str
    Specifies the identifier for the Iceberg table; must be unique for the schema in which the Iceberg table is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    parameters Sequence[IcebergTableFromRestParameterArgs]
    Outputs the result of SHOW PARAMETERS IN ICEBERG TABLE for the given Iceberg table.
    path_layout str
    Specifies the storage layout for the Iceberg table's Parquet files. Valid values are: [FLAT HIERARCHICAL]. Cannot be changed after creation. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    replace_invalid_characters bool
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. For more information, check REPLACEINVALIDCHARACTERS docs.
    schema str
    The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    show_outputs Sequence[IcebergTableFromRestShowOutputArgs]
    Outputs the result of SHOW ICEBERG TABLES for the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
    storage_serialization_policy str
    Specifies the storage serialization policy for the Iceberg table. Valid values are: [COMPATIBLE OPTIMIZED]. Cannot be changed after creation. For more information, check STORAGESERIALIZATIONPOLICY docs.
    target_file_size str
    Specifies the target file size (in bytes) used when writing the Iceberg table's Parquet files. Valid values are: [AUTO 16MB 32MB 64MB 128MB]. For more information, check TARGETFILESIZE docs.
    autoRefresh String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether Snowflake should periodically refresh the Iceberg table metadata from the external catalog. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    catalog String
    Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
    catalogNamespace String
    Specifies the namespace (or database) in the external catalog that the table belongs to. If not specified, the catalog integration's default namespace is used.
    catalogTableName String
    Specifies the name of the table as it appears in the external catalog.
    comment String
    Specifies a comment for the Iceberg table.
    database String
    The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE ICEBERG TABLE for the given Iceberg table.
    enableIcebergMergeOnRead Boolean
    Specifies whether merge-on-read is enabled for the Iceberg table. For more information, check ENABLEICEBERGMERGEONREAD docs.
    externalVolume String
    Specifies the identifier for the external volume where the Iceberg table stores its metadata files and data in Parquet format. If not specified, the account-level default is used.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    icebergMergeOnReadBehavior String
    Specifies the merge-on-read behavior for the Iceberg table. Valid values are: [AUTO ENABLED DISABLED]. Cannot be changed after creation. For more information, check ICEBERGMERGEONREADBEHAVIOR docs.
    name String
    Specifies the identifier for the Iceberg table; must be unique for the schema in which the Iceberg table is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    parameters List<Property Map>
    Outputs the result of SHOW PARAMETERS IN ICEBERG TABLE for the given Iceberg table.
    pathLayout String
    Specifies the storage layout for the Iceberg table's Parquet files. Valid values are: [FLAT HIERARCHICAL]. Cannot be changed after creation. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    replaceInvalidCharacters Boolean
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. For more information, check REPLACEINVALIDCHARACTERS docs.
    schema String
    The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs List<Property Map>
    Outputs the result of SHOW ICEBERG TABLES for the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
    storageSerializationPolicy String
    Specifies the storage serialization policy for the Iceberg table. Valid values are: [COMPATIBLE OPTIMIZED]. Cannot be changed after creation. For more information, check STORAGESERIALIZATIONPOLICY docs.
    targetFileSize String
    Specifies the target file size (in bytes) used when writing the Iceberg table's Parquet files. Valid values are: [AUTO 16MB 32MB 64MB 128MB]. For more information, check TARGETFILESIZE docs.

    Supporting Types

    IcebergTableFromRestDescribeOutput, IcebergTableFromRestDescribeOutputArgs

    Check string
    Comment string
    Default string
    Expression string
    IsNullable bool
    Kind string
    Name string
    NameMapping string
    PolicyName string
    PrimaryKey bool
    PrivacyDomain string
    SourceIcebergType string
    Type string
    UniqueKey bool
    WriteDefault string
    Check string
    Comment string
    Default string
    Expression string
    IsNullable bool
    Kind string
    Name string
    NameMapping string
    PolicyName string
    PrimaryKey bool
    PrivacyDomain string
    SourceIcebergType string
    Type string
    UniqueKey bool
    WriteDefault string
    check string
    comment string
    default string
    expression string
    is_nullable bool
    kind string
    name string
    name_mapping string
    policy_name string
    primary_key bool
    privacy_domain string
    source_iceberg_type string
    type string
    unique_key bool
    write_default string
    check String
    comment String
    default_ String
    expression String
    isNullable Boolean
    kind String
    name String
    nameMapping String
    policyName String
    primaryKey Boolean
    privacyDomain String
    sourceIcebergType String
    type String
    uniqueKey Boolean
    writeDefault String
    check string
    comment string
    default string
    expression string
    isNullable boolean
    kind string
    name string
    nameMapping string
    policyName string
    primaryKey boolean
    privacyDomain string
    sourceIcebergType string
    type string
    uniqueKey boolean
    writeDefault string
    check String
    comment String
    default String
    expression String
    isNullable Boolean
    kind String
    name String
    nameMapping String
    policyName String
    primaryKey Boolean
    privacyDomain String
    sourceIcebergType String
    type String
    uniqueKey Boolean
    writeDefault String

    IcebergTableFromRestParameter, IcebergTableFromRestParameterArgs

    IcebergTableFromRestParameterCatalog, IcebergTableFromRestParameterCatalogArgs

    Default string
    Description string
    Key string
    Level string
    Value string
    Default string
    Description string
    Key string
    Level string
    Value string
    default string
    description string
    key string
    level string
    value string
    default_ String
    description String
    key String
    level String
    value String
    default string
    description string
    key string
    level string
    value string
    default String
    description String
    key String
    level String
    value String

    IcebergTableFromRestParameterEnableIcebergMergeOnRead, IcebergTableFromRestParameterEnableIcebergMergeOnReadArgs

    Default string
    Description string
    Key string
    Level string
    Value string
    Default string
    Description string
    Key string
    Level string
    Value string
    default string
    description string
    key string
    level string
    value string
    default_ String
    description String
    key String
    level String
    value String
    default string
    description string
    key string
    level string
    value string
    default String
    description String
    key String
    level String
    value String

    IcebergTableFromRestParameterExternalVolume, IcebergTableFromRestParameterExternalVolumeArgs

    Default string
    Description string
    Key string
    Level string
    Value string
    Default string
    Description string
    Key string
    Level string
    Value string
    default string
    description string
    key string
    level string
    value string
    default_ String
    description String
    key String
    level String
    value String
    default string
    description string
    key string
    level string
    value string
    default String
    description String
    key String
    level String
    value String

    IcebergTableFromRestParameterIcebergMergeOnReadBehavior, IcebergTableFromRestParameterIcebergMergeOnReadBehaviorArgs

    Default string
    Description string
    Key string
    Level string
    Value string
    Default string
    Description string
    Key string
    Level string
    Value string
    default string
    description string
    key string
    level string
    value string
    default_ String
    description String
    key String
    level String
    value String
    default string
    description string
    key string
    level string
    value string
    default String
    description String
    key String
    level String
    value String

    IcebergTableFromRestParameterReplaceInvalidCharacter, IcebergTableFromRestParameterReplaceInvalidCharacterArgs

    Default string
    Description string
    Key string
    Level string
    Value string
    Default string
    Description string
    Key string
    Level string
    Value string
    default string
    description string
    key string
    level string
    value string
    default_ String
    description String
    key String
    level String
    value String
    default string
    description string
    key string
    level string
    value string
    default String
    description String
    key String
    level String
    value String

    IcebergTableFromRestParameterStorageSerializationPolicy, IcebergTableFromRestParameterStorageSerializationPolicyArgs

    Default string
    Description string
    Key string
    Level string
    Value string
    Default string
    Description string
    Key string
    Level string
    Value string
    default string
    description string
    key string
    level string
    value string
    default_ String
    description String
    key String
    level String
    value String
    default string
    description string
    key string
    level string
    value string
    default String
    description String
    key String
    level String
    value String

    IcebergTableFromRestParameterTargetFileSize, IcebergTableFromRestParameterTargetFileSizeArgs

    Default string
    Description string
    Key string
    Level string
    Value string
    Default string
    Description string
    Key string
    Level string
    Value string
    default string
    description string
    key string
    level string
    value string
    default_ String
    description String
    key String
    level String
    value String
    default string
    description string
    key string
    level string
    value string
    default String
    description String
    key String
    level String
    value String

    IcebergTableFromRestShowOutput, IcebergTableFromRestShowOutputArgs

    IcebergTableFromRestShowOutputAutoRefreshStatus, IcebergTableFromRestShowOutputAutoRefreshStatusArgs

    IcebergTableFromRestShowOutputPartitionSpec, IcebergTableFromRestShowOutputPartitionSpecArgs

    IcebergTableFromRestShowOutputPartitionSpecField, IcebergTableFromRestShowOutputPartitionSpecFieldArgs

    FieldId int
    Name string
    SourceId int
    Transform string
    FieldId int
    Name string
    SourceId int
    Transform string
    field_id number
    name string
    source_id number
    transform string
    fieldId Integer
    name String
    sourceId Integer
    transform String
    fieldId number
    name string
    sourceId number
    transform string
    fieldId Number
    name String
    sourceId Number
    transform String

    Import

    $ pulumi import snowflake:index/icebergTableFromRest:IcebergTableFromRest example '"<database_name>"."<schema_name>"."<table_name>"'

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

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Viewing docs for Snowflake v2.19.0
    published on Friday, Jul 31, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-snowflake

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial