published on Wednesday, Jul 8, 2026 by Pulumi
published on Wednesday, Jul 8, 2026 by Pulumi
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
previewFeaturesEnabledfield 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.
Resource used to manage an Iceberg table whose metadata is created from an existing Apache Iceberg metadata file in an external volume. 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.IcebergTableFromFiles("basic", {
database: "DATABASE",
schema: "SCHEMA",
name: "TABLE",
metadataFilePath: "path/to/metadata/v1.metadata.json",
externalVolume: "my_external_volume",
});
// Complete - all fields set
const complete = new snowflake.IcebergTableFromFiles("complete", {
database: "DATABASE",
schema: "SCHEMA",
name: "TABLE",
metadataFilePath: "path/to/metadata/v1.metadata.json",
externalVolume: "EXTERNAL_VOLUME",
catalog: "CATALOG",
comment: "COMMENT",
replaceInvalidCharacters: true,
});
import pulumi
import pulumi_snowflake as snowflake
# Basic - only required fields
basic = snowflake.IcebergTableFromFiles("basic",
database="DATABASE",
schema="SCHEMA",
name="TABLE",
metadata_file_path="path/to/metadata/v1.metadata.json",
external_volume="my_external_volume")
# Complete - all fields set
complete = snowflake.IcebergTableFromFiles("complete",
database="DATABASE",
schema="SCHEMA",
name="TABLE",
metadata_file_path="path/to/metadata/v1.metadata.json",
external_volume="EXTERNAL_VOLUME",
catalog="CATALOG",
comment="COMMENT",
replace_invalid_characters=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.NewIcebergTableFromFiles(ctx, "basic", &snowflake.IcebergTableFromFilesArgs{
Database: pulumi.String("DATABASE"),
Schema: pulumi.String("SCHEMA"),
Name: pulumi.String("TABLE"),
MetadataFilePath: pulumi.String("path/to/metadata/v1.metadata.json"),
ExternalVolume: pulumi.String("my_external_volume"),
})
if err != nil {
return err
}
// Complete - all fields set
_, err = snowflake.NewIcebergTableFromFiles(ctx, "complete", &snowflake.IcebergTableFromFilesArgs{
Database: pulumi.String("DATABASE"),
Schema: pulumi.String("SCHEMA"),
Name: pulumi.String("TABLE"),
MetadataFilePath: pulumi.String("path/to/metadata/v1.metadata.json"),
ExternalVolume: pulumi.String("EXTERNAL_VOLUME"),
Catalog: pulumi.String("CATALOG"),
Comment: pulumi.String("COMMENT"),
ReplaceInvalidCharacters: 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.IcebergTableFromFiles("basic", new()
{
Database = "DATABASE",
Schema = "SCHEMA",
Name = "TABLE",
MetadataFilePath = "path/to/metadata/v1.metadata.json",
ExternalVolume = "my_external_volume",
});
// Complete - all fields set
var complete = new Snowflake.IcebergTableFromFiles("complete", new()
{
Database = "DATABASE",
Schema = "SCHEMA",
Name = "TABLE",
MetadataFilePath = "path/to/metadata/v1.metadata.json",
ExternalVolume = "EXTERNAL_VOLUME",
Catalog = "CATALOG",
Comment = "COMMENT",
ReplaceInvalidCharacters = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.IcebergTableFromFiles;
import com.pulumi.snowflake.IcebergTableFromFilesArgs;
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 IcebergTableFromFiles("basic", IcebergTableFromFilesArgs.builder()
.database("DATABASE")
.schema("SCHEMA")
.name("TABLE")
.metadataFilePath("path/to/metadata/v1.metadata.json")
.externalVolume("my_external_volume")
.build());
// Complete - all fields set
var complete = new IcebergTableFromFiles("complete", IcebergTableFromFilesArgs.builder()
.database("DATABASE")
.schema("SCHEMA")
.name("TABLE")
.metadataFilePath("path/to/metadata/v1.metadata.json")
.externalVolume("EXTERNAL_VOLUME")
.catalog("CATALOG")
.comment("COMMENT")
.replaceInvalidCharacters(true)
.build());
}
}
resources:
# Basic - only required fields
basic:
type: snowflake:IcebergTableFromFiles
properties:
database: DATABASE
schema: SCHEMA
name: TABLE
metadataFilePath: path/to/metadata/v1.metadata.json
externalVolume: my_external_volume
# Complete - all fields set
complete:
type: snowflake:IcebergTableFromFiles
properties:
database: DATABASE
schema: SCHEMA
name: TABLE
metadataFilePath: path/to/metadata/v1.metadata.json
externalVolume: EXTERNAL_VOLUME
catalog: CATALOG
comment: COMMENT
replaceInvalidCharacters: true
pulumi {
required_providers {
snowflake = {
source = "pulumi/snowflake"
}
}
}
# Basic - only required fields
resource "snowflake_icebergtablefromfiles" "basic" {
database = "DATABASE"
schema = "SCHEMA"
name = "TABLE"
metadata_file_path = "path/to/metadata/v1.metadata.json"
external_volume = "my_external_volume"
}
# Complete - all fields set
resource "snowflake_icebergtablefromfiles" "complete" {
database = "DATABASE"
schema = "SCHEMA"
name = "TABLE"
metadata_file_path = "path/to/metadata/v1.metadata.json"
external_volume = "EXTERNAL_VOLUME"
catalog = "CATALOG"
comment = "COMMENT"
replace_invalid_characters = 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.
Note External changes to
metadataFilePathare not detected. This value is not read back from Snowflake during refresh, so updates to the underlying Iceberg metadata file (for example, refreshing the table to a new metadata file outside of Terraform) will not produce a drift in the pulumi preview. After import, the firstpulumi previewmay show a resource recreation for write-only non-alterable fields that are not reconciled with Snowflake. Runpulumi uponce to sync these values into state.
Create IcebergTableFromFiles Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IcebergTableFromFiles(name: string, args: IcebergTableFromFilesArgs, opts?: CustomResourceOptions);@overload
def IcebergTableFromFiles(resource_name: str,
args: IcebergTableFromFilesArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IcebergTableFromFiles(resource_name: str,
opts: Optional[ResourceOptions] = None,
database: Optional[str] = None,
metadata_file_path: Optional[str] = None,
schema: Optional[str] = None,
catalog: Optional[str] = None,
comment: Optional[str] = None,
external_volume: Optional[str] = None,
name: Optional[str] = None,
replace_invalid_characters: Optional[bool] = None)func NewIcebergTableFromFiles(ctx *Context, name string, args IcebergTableFromFilesArgs, opts ...ResourceOption) (*IcebergTableFromFiles, error)public IcebergTableFromFiles(string name, IcebergTableFromFilesArgs args, CustomResourceOptions? opts = null)
public IcebergTableFromFiles(String name, IcebergTableFromFilesArgs args)
public IcebergTableFromFiles(String name, IcebergTableFromFilesArgs args, CustomResourceOptions options)
type: snowflake:IcebergTableFromFiles
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "snowflake_iceberg_table_from_files" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args IcebergTableFromFilesArgs
- 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 IcebergTableFromFilesArgs
- 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 IcebergTableFromFilesArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IcebergTableFromFilesArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IcebergTableFromFilesArgs
- 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 icebergTableFromFilesResource = new Snowflake.IcebergTableFromFiles("icebergTableFromFilesResource", new()
{
Database = "string",
MetadataFilePath = "string",
Schema = "string",
Catalog = "string",
Comment = "string",
ExternalVolume = "string",
Name = "string",
ReplaceInvalidCharacters = false,
});
example, err := snowflake.NewIcebergTableFromFiles(ctx, "icebergTableFromFilesResource", &snowflake.IcebergTableFromFilesArgs{
Database: pulumi.String("string"),
MetadataFilePath: pulumi.String("string"),
Schema: pulumi.String("string"),
Catalog: pulumi.String("string"),
Comment: pulumi.String("string"),
ExternalVolume: pulumi.String("string"),
Name: pulumi.String("string"),
ReplaceInvalidCharacters: pulumi.Bool(false),
})
resource "snowflake_iceberg_table_from_files" "icebergTableFromFilesResource" {
lifecycle {
create_before_destroy = true
}
database = "string"
metadata_file_path = "string"
schema = "string"
catalog = "string"
comment = "string"
external_volume = "string"
name = "string"
replace_invalid_characters = false
}
var icebergTableFromFilesResource = new IcebergTableFromFiles("icebergTableFromFilesResource", IcebergTableFromFilesArgs.builder()
.database("string")
.metadataFilePath("string")
.schema("string")
.catalog("string")
.comment("string")
.externalVolume("string")
.name("string")
.replaceInvalidCharacters(false)
.build());
iceberg_table_from_files_resource = snowflake.IcebergTableFromFiles("icebergTableFromFilesResource",
database="string",
metadata_file_path="string",
schema="string",
catalog="string",
comment="string",
external_volume="string",
name="string",
replace_invalid_characters=False)
const icebergTableFromFilesResource = new snowflake.IcebergTableFromFiles("icebergTableFromFilesResource", {
database: "string",
metadataFilePath: "string",
schema: "string",
catalog: "string",
comment: "string",
externalVolume: "string",
name: "string",
replaceInvalidCharacters: false,
});
type: snowflake:IcebergTableFromFiles
properties:
catalog: string
comment: string
database: string
externalVolume: string
metadataFilePath: string
name: string
replaceInvalidCharacters: false
schema: string
IcebergTableFromFiles 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 IcebergTableFromFiles resource accepts the following input properties:
- Database string
- The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Metadata
File stringPath - Specifies the relative path of the Iceberg metadata file in the external volume. 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".
- Schema string
- The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Catalog string
- Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
- Comment string
- Specifies a comment for the Iceberg table.
- 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.
- 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:
|,.,". - Replace
Invalid boolCharacters - 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.
- Database string
- The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Metadata
File stringPath - Specifies the relative path of the Iceberg metadata file in the external volume. 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".
- Schema string
- The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Catalog string
- Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
- Comment string
- Specifies a comment for the Iceberg table.
- 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.
- 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:
|,.,". - Replace
Invalid boolCharacters - 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.
- database string
- The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - metadata_
file_ stringpath - Specifies the relative path of the Iceberg metadata file in the external volume. 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".
- schema string
- The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - catalog string
- Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
- comment string
- Specifies a comment for the Iceberg table.
- 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.
- 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:
|,.,". - replace_
invalid_ boolcharacters - 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.
- database String
- The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - metadata
File StringPath - Specifies the relative path of the Iceberg metadata file in the external volume. 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".
- schema String
- The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - catalog String
- Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
- comment String
- Specifies a comment for the Iceberg table.
- 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.
- 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:
|,.,". - replace
Invalid BooleanCharacters - 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.
- database string
- The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - metadata
File stringPath - Specifies the relative path of the Iceberg metadata file in the external volume. 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".
- schema string
- The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - catalog string
- Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
- comment string
- Specifies a comment for the Iceberg table.
- 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.
- 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:
|,.,". - replace
Invalid booleanCharacters - 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.
- database str
- The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - metadata_
file_ strpath - Specifies the relative path of the Iceberg metadata file in the external volume. 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".
- schema str
- The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - catalog str
- Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
- comment str
- Specifies a comment for the Iceberg table.
- 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.
- 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:
|,.,". - replace_
invalid_ boolcharacters - 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.
- database String
- The database in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - metadata
File StringPath - Specifies the relative path of the Iceberg metadata file in the external volume. 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".
- schema String
- The schema in which to create the Iceberg table. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - catalog String
- Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
- comment String
- Specifies a comment for the Iceberg table.
- 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.
- 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:
|,.,". - replace
Invalid BooleanCharacters - 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the IcebergTableFromFiles resource produces the following output properties:
- Describe
Outputs List<IcebergTable From Files Describe Output> - Outputs the result of
DESCRIBE ICEBERG TABLEfor the given Iceberg table. - Fully
Qualified stringName - 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<Iceberg
Table From Files Parameter> - Outputs the result of
SHOW PARAMETERS IN ICEBERG TABLEfor the given Iceberg table. - Show
Outputs List<IcebergTable From Files Show Output> - Outputs the result of
SHOW ICEBERG TABLESfor the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
- Describe
Outputs []IcebergTable From Files Describe Output - Outputs the result of
DESCRIBE ICEBERG TABLEfor the given Iceberg table. - Fully
Qualified stringName - 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
[]Iceberg
Table From Files Parameter - Outputs the result of
SHOW PARAMETERS IN ICEBERG TABLEfor the given Iceberg table. - Show
Outputs []IcebergTable From Files Show Output - Outputs the result of
SHOW ICEBERG TABLESfor 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 TABLEfor the given Iceberg table. - fully_
qualified_ stringname - 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 TABLEfor the given Iceberg table. - show_
outputs list(object) - Outputs the result of
SHOW ICEBERG TABLESfor the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
- describe
Outputs List<IcebergTable From Files Describe Output> - Outputs the result of
DESCRIBE ICEBERG TABLEfor the given Iceberg table. - fully
Qualified StringName - 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<Iceberg
Table From Files Parameter> - Outputs the result of
SHOW PARAMETERS IN ICEBERG TABLEfor the given Iceberg table. - show
Outputs List<IcebergTable From Files Show Output> - Outputs the result of
SHOW ICEBERG TABLESfor the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
- describe
Outputs IcebergTable From Files Describe Output[] - Outputs the result of
DESCRIBE ICEBERG TABLEfor the given Iceberg table. - fully
Qualified stringName - 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
Iceberg
Table From Files Parameter[] - Outputs the result of
SHOW PARAMETERS IN ICEBERG TABLEfor the given Iceberg table. - show
Outputs IcebergTable From Files Show Output[] - Outputs the result of
SHOW ICEBERG TABLESfor the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
- describe_
outputs Sequence[IcebergTable From Files Describe Output] - Outputs the result of
DESCRIBE ICEBERG TABLEfor the given Iceberg table. - fully_
qualified_ strname - 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[Iceberg
Table From Files Parameter] - Outputs the result of
SHOW PARAMETERS IN ICEBERG TABLEfor the given Iceberg table. - show_
outputs Sequence[IcebergTable From Files Show Output] - Outputs the result of
SHOW ICEBERG TABLESfor the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
- describe
Outputs List<Property Map> - Outputs the result of
DESCRIBE ICEBERG TABLEfor the given Iceberg table. - fully
Qualified StringName - 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 TABLEfor the given Iceberg table. - show
Outputs List<Property Map> - Outputs the result of
SHOW ICEBERG TABLESfor the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
Look up Existing IcebergTableFromFiles Resource
Get an existing IcebergTableFromFiles 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?: IcebergTableFromFilesState, opts?: CustomResourceOptions): IcebergTableFromFiles@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
catalog: Optional[str] = None,
comment: Optional[str] = None,
database: Optional[str] = None,
describe_outputs: Optional[Sequence[IcebergTableFromFilesDescribeOutputArgs]] = None,
external_volume: Optional[str] = None,
fully_qualified_name: Optional[str] = None,
metadata_file_path: Optional[str] = None,
name: Optional[str] = None,
parameters: Optional[Sequence[IcebergTableFromFilesParameterArgs]] = None,
replace_invalid_characters: Optional[bool] = None,
schema: Optional[str] = None,
show_outputs: Optional[Sequence[IcebergTableFromFilesShowOutputArgs]] = None) -> IcebergTableFromFilesfunc GetIcebergTableFromFiles(ctx *Context, name string, id IDInput, state *IcebergTableFromFilesState, opts ...ResourceOption) (*IcebergTableFromFiles, error)public static IcebergTableFromFiles Get(string name, Input<string> id, IcebergTableFromFilesState? state, CustomResourceOptions? opts = null)public static IcebergTableFromFiles get(String name, Output<String> id, IcebergTableFromFilesState state, CustomResourceOptions options)resources: _: type: snowflake:IcebergTableFromFiles get: id: ${id}import {
to = snowflake_iceberg_table_from_files.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.
- Catalog string
- Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
- 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<IcebergTable From Files Describe Output> - Outputs the result of
DESCRIBE ICEBERG TABLEfor the given Iceberg table. - 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 stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Metadata
File stringPath - Specifies the relative path of the Iceberg metadata file in the external volume. 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".
- 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<Iceberg
Table From Files Parameter> - Outputs the result of
SHOW PARAMETERS IN ICEBERG TABLEfor the given Iceberg table. - Replace
Invalid boolCharacters - 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<IcebergTable From Files Show Output> - Outputs the result of
SHOW ICEBERG TABLESfor the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
- Catalog string
- Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
- 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 []IcebergTable From Files Describe Output Args - Outputs the result of
DESCRIBE ICEBERG TABLEfor the given Iceberg table. - 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 stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Metadata
File stringPath - Specifies the relative path of the Iceberg metadata file in the external volume. 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".
- 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
[]Iceberg
Table From Files Parameter Args - Outputs the result of
SHOW PARAMETERS IN ICEBERG TABLEfor the given Iceberg table. - Replace
Invalid boolCharacters - 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 []IcebergTable From Files Show Output Args - Outputs the result of
SHOW ICEBERG TABLESfor the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
- catalog string
- Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
- 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 TABLEfor the given Iceberg table. - 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_ stringname - Fully qualified name of the resource. For more information, see object name resolution.
- metadata_
file_ stringpath - Specifies the relative path of the Iceberg metadata file in the external volume. 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".
- 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 TABLEfor the given Iceberg table. - replace_
invalid_ boolcharacters - 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 TABLESfor the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
- catalog String
- Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
- 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<IcebergTable From Files Describe Output> - Outputs the result of
DESCRIBE ICEBERG TABLEfor the given Iceberg table. - 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 StringName - Fully qualified name of the resource. For more information, see object name resolution.
- metadata
File StringPath - Specifies the relative path of the Iceberg metadata file in the external volume. 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".
- 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<Iceberg
Table From Files Parameter> - Outputs the result of
SHOW PARAMETERS IN ICEBERG TABLEfor the given Iceberg table. - replace
Invalid BooleanCharacters - 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<IcebergTable From Files Show Output> - Outputs the result of
SHOW ICEBERG TABLESfor the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
- catalog string
- Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
- 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 IcebergTable From Files Describe Output[] - Outputs the result of
DESCRIBE ICEBERG TABLEfor the given Iceberg table. - 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 stringName - Fully qualified name of the resource. For more information, see object name resolution.
- metadata
File stringPath - Specifies the relative path of the Iceberg metadata file in the external volume. 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".
- 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
Iceberg
Table From Files Parameter[] - Outputs the result of
SHOW PARAMETERS IN ICEBERG TABLEfor the given Iceberg table. - replace
Invalid booleanCharacters - 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 IcebergTable From Files Show Output[] - Outputs the result of
SHOW ICEBERG TABLESfor the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
- catalog str
- Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
- 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[IcebergTable From Files Describe Output Args] - Outputs the result of
DESCRIBE ICEBERG TABLEfor the given Iceberg table. - 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_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- metadata_
file_ strpath - Specifies the relative path of the Iceberg metadata file in the external volume. 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".
- 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[Iceberg
Table From Files Parameter Args] - Outputs the result of
SHOW PARAMETERS IN ICEBERG TABLEfor the given Iceberg table. - replace_
invalid_ boolcharacters - 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[IcebergTable From Files Show Output Args] - Outputs the result of
SHOW ICEBERG TABLESfor the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
- catalog String
- Specifies the identifier for the catalog integration to use for the Iceberg table. If not specified, the account-level default is used.
- 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<Property Map> - Outputs the result of
DESCRIBE ICEBERG TABLEfor the given Iceberg table. - 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 StringName - Fully qualified name of the resource. For more information, see object name resolution.
- metadata
File StringPath - Specifies the relative path of the Iceberg metadata file in the external volume. 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".
- 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 TABLEfor the given Iceberg table. - replace
Invalid BooleanCharacters - 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<Property Map> - Outputs the result of
SHOW ICEBERG TABLESfor the given Iceberg table. Note that this value will be only recomputed whenever values of fields affecting the output change.
Supporting Types
IcebergTableFromFilesDescribeOutput, IcebergTableFromFilesDescribeOutputArgs
- 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 stringType - Type string
- Unique
Key bool - Write
Default 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 stringType - Type string
- Unique
Key bool - Write
Default 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_ stringtype - type string
- unique_
key bool - write_
default string
- check String
- comment String
- default_ String
- expression String
- is
Nullable Boolean - kind String
- name String
- name
Mapping String - policy
Name String - primary
Key Boolean - privacy
Domain String - source
Iceberg StringType - type String
- unique
Key Boolean - write
Default String
- check string
- comment string
- default string
- expression string
- is
Nullable boolean - kind string
- name string
- name
Mapping string - policy
Name string - primary
Key boolean - privacy
Domain string - source
Iceberg stringType - type string
- unique
Key boolean - write
Default string
- check str
- comment str
- default str
- expression str
- is_
nullable bool - kind str
- name str
- name_
mapping str - policy_
name str - primary_
key bool - privacy_
domain str - source_
iceberg_ strtype - type str
- unique_
key bool - write_
default str
- check String
- comment String
- default String
- expression String
- is
Nullable Boolean - kind String
- name String
- name
Mapping String - policy
Name String - primary
Key Boolean - privacy
Domain String - source
Iceberg StringType - type String
- unique
Key Boolean - write
Default String
IcebergTableFromFilesParameter, IcebergTableFromFilesParameterArgs
IcebergTableFromFilesParameterCatalog, IcebergTableFromFilesParameterCatalogArgs
- 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 str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
IcebergTableFromFilesParameterExternalVolume, IcebergTableFromFilesParameterExternalVolumeArgs
- 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 str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
IcebergTableFromFilesParameterReplaceInvalidCharacter, IcebergTableFromFilesParameterReplaceInvalidCharacterArgs
- 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 str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
IcebergTableFromFilesShowOutput, IcebergTableFromFilesShowOutputArgs
- Auto
Refresh List<IcebergStatuses Table From Files Show Output Auto Refresh Status> - Base
Location string - Can
Write boolMetadata - Catalog
Name string - Catalog
Namespace string - Catalog
Sync stringName - Catalog
Table stringName - Comment string
- Created
On string - Current
Partition intSpec Id - Database
Name string - External
Volume stringName - Iceberg
Table intFormat Version - Iceberg
Table stringType - Name string
- Name
Mapping string - Owner string
- Owner
Role stringType - Partition
Specs string - Schema
Name string
- Auto
Refresh []IcebergStatuses Table From Files Show Output Auto Refresh Status - Base
Location string - Can
Write boolMetadata - Catalog
Name string - Catalog
Namespace string - Catalog
Sync stringName - Catalog
Table stringName - Comment string
- Created
On string - Current
Partition intSpec Id - Database
Name string - External
Volume stringName - Iceberg
Table intFormat Version - Iceberg
Table stringType - Name string
- Name
Mapping string - Owner string
- Owner
Role stringType - Partition
Specs string - Schema
Name string
- auto_
refresh_ list(object)statuses - base_
location string - can_
write_ boolmetadata - catalog_
name string - catalog_
namespace string - catalog_
sync_ stringname - catalog_
table_ stringname - comment string
- created_
on string - current_
partition_ numberspec_ id - database_
name string - external_
volume_ stringname - iceberg_
table_ numberformat_ version - iceberg_
table_ stringtype - name string
- name_
mapping string - owner string
- owner_
role_ stringtype - partition_
specs string - schema_
name string
- auto
Refresh List<IcebergStatuses Table From Files Show Output Auto Refresh Status> - base
Location String - can
Write BooleanMetadata - catalog
Name String - catalog
Namespace String - catalog
Sync StringName - catalog
Table StringName - comment String
- created
On String - current
Partition IntegerSpec Id - database
Name String - external
Volume StringName - iceberg
Table IntegerFormat Version - iceberg
Table StringType - name String
- name
Mapping String - owner String
- owner
Role StringType - partition
Specs String - schema
Name String
- auto
Refresh IcebergStatuses Table From Files Show Output Auto Refresh Status[] - base
Location string - can
Write booleanMetadata - catalog
Name string - catalog
Namespace string - catalog
Sync stringName - catalog
Table stringName - comment string
- created
On string - current
Partition numberSpec Id - database
Name string - external
Volume stringName - iceberg
Table numberFormat Version - iceberg
Table stringType - name string
- name
Mapping string - owner string
- owner
Role stringType - partition
Specs string - schema
Name string
- auto_
refresh_ Sequence[Icebergstatuses Table From Files Show Output Auto Refresh Status] - base_
location str - can_
write_ boolmetadata - catalog_
name str - catalog_
namespace str - catalog_
sync_ strname - catalog_
table_ strname - comment str
- created_
on str - current_
partition_ intspec_ id - database_
name str - external_
volume_ strname - iceberg_
table_ intformat_ version - iceberg_
table_ strtype - name str
- name_
mapping str - owner str
- owner_
role_ strtype - partition_
specs str - schema_
name str
- auto
Refresh List<Property Map>Statuses - base
Location String - can
Write BooleanMetadata - catalog
Name String - catalog
Namespace String - catalog
Sync StringName - catalog
Table StringName - comment String
- created
On String - current
Partition NumberSpec Id - database
Name String - external
Volume StringName - iceberg
Table NumberFormat Version - iceberg
Table StringType - name String
- name
Mapping String - owner String
- owner
Role StringType - partition
Specs String - schema
Name String
IcebergTableFromFilesShowOutputAutoRefreshStatus, IcebergTableFromFilesShowOutputAutoRefreshStatusArgs
- Current
Snapshot intId - Execution
State string - Last
Snapshot stringTime - Last
Updated stringTime - Pending
Snapshot intCount
- Current
Snapshot intId - Execution
State string - Last
Snapshot stringTime - Last
Updated stringTime - Pending
Snapshot intCount
- current_
snapshot_ numberid - execution_
state string - last_
snapshot_ stringtime - last_
updated_ stringtime - pending_
snapshot_ numbercount
- current
Snapshot IntegerId - execution
State String - last
Snapshot StringTime - last
Updated StringTime - pending
Snapshot IntegerCount
- current
Snapshot numberId - execution
State string - last
Snapshot stringTime - last
Updated stringTime - pending
Snapshot numberCount
- current
Snapshot NumberId - execution
State String - last
Snapshot StringTime - last
Updated StringTime - pending
Snapshot NumberCount
Import
$ pulumi import snowflake:index/icebergTableFromFiles:IcebergTableFromFiles 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
snowflakeTerraform Provider.
published on Wednesday, Jul 8, 2026 by Pulumi