Snowflake v0.59.0, Sep 20 24

Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi

snowflake.Schema

Explore with Pulumi AI

Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi

pulumi/pulumi-snowflake

Import

format is <database_name>.<schema_name>

$ pulumi import snowflake:index/schema:Schema example '"<database_name>"."<schema_name>"'

Create Schema Resource

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

Constructor syntax

new Schema(name: string, args: SchemaArgs, opts?: CustomResourceOptions);

@overload
def Schema(resource_name: str,
           args: SchemaArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Schema(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           database: Optional[str] = None,
           name: Optional[str] = None,
           enable_console_output: Optional[bool] = None,
           pipe_execution_paused: Optional[bool] = None,
           replace_invalid_characters: Optional[bool] = None,
           quoted_identifiers_ignore_case: Optional[bool] = None,
           external_volume: Optional[str] = None,
           is_transient: Optional[str] = None,
           log_level: Optional[str] = None,
           max_data_extension_time_in_days: Optional[int] = None,
           catalog: Optional[str] = None,
           comment: Optional[str] = None,
           data_retention_time_in_days: Optional[int] = None,
           default_ddl_collation: Optional[str] = None,
           storage_serialization_policy: Optional[str] = None,
           suspend_task_after_num_failures: Optional[int] = None,
           task_auto_retry_attempts: Optional[int] = None,
           trace_level: Optional[str] = None,
           user_task_managed_initial_warehouse_size: Optional[str] = None,
           user_task_minimum_trigger_interval_in_seconds: Optional[int] = None,
           user_task_timeout_ms: Optional[int] = None,
           with_managed_access: Optional[str] = None)

func NewSchema(ctx *Context, name string, args SchemaArgs, opts ...ResourceOption) (*Schema, error)

public Schema(string name, SchemaArgs args, CustomResourceOptions? opts = null)

public Schema(String name, SchemaArgs args)
public Schema(String name, SchemaArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args SchemaArgs: 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 SchemaArgs: 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 SchemaArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SchemaArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SchemaArgs: 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 schemaResource = new Snowflake.Schema("schemaResource", new()
{
    Database = "string",
    Name = "string",
    EnableConsoleOutput = false,
    PipeExecutionPaused = false,
    ReplaceInvalidCharacters = false,
    QuotedIdentifiersIgnoreCase = false,
    ExternalVolume = "string",
    IsTransient = "string",
    LogLevel = "string",
    MaxDataExtensionTimeInDays = 0,
    Catalog = "string",
    Comment = "string",
    DataRetentionTimeInDays = 0,
    DefaultDdlCollation = "string",
    StorageSerializationPolicy = "string",
    SuspendTaskAfterNumFailures = 0,
    TaskAutoRetryAttempts = 0,
    TraceLevel = "string",
    UserTaskManagedInitialWarehouseSize = "string",
    UserTaskMinimumTriggerIntervalInSeconds = 0,
    UserTaskTimeoutMs = 0,
    WithManagedAccess = "string",
});

example, err := snowflake.NewSchema(ctx, "schemaResource", &snowflake.SchemaArgs{
	Database:                                pulumi.String("string"),
	Name:                                    pulumi.String("string"),
	EnableConsoleOutput:                     pulumi.Bool(false),
	PipeExecutionPaused:                     pulumi.Bool(false),
	ReplaceInvalidCharacters:                pulumi.Bool(false),
	QuotedIdentifiersIgnoreCase:             pulumi.Bool(false),
	ExternalVolume:                          pulumi.String("string"),
	IsTransient:                             pulumi.String("string"),
	LogLevel:                                pulumi.String("string"),
	MaxDataExtensionTimeInDays:              pulumi.Int(0),
	Catalog:                                 pulumi.String("string"),
	Comment:                                 pulumi.String("string"),
	DataRetentionTimeInDays:                 pulumi.Int(0),
	DefaultDdlCollation:                     pulumi.String("string"),
	StorageSerializationPolicy:              pulumi.String("string"),
	SuspendTaskAfterNumFailures:             pulumi.Int(0),
	TaskAutoRetryAttempts:                   pulumi.Int(0),
	TraceLevel:                              pulumi.String("string"),
	UserTaskManagedInitialWarehouseSize:     pulumi.String("string"),
	UserTaskMinimumTriggerIntervalInSeconds: pulumi.Int(0),
	UserTaskTimeoutMs:                       pulumi.Int(0),
	WithManagedAccess:                       pulumi.String("string"),
})

var schemaResource = new Schema("schemaResource", SchemaArgs.builder()
    .database("string")
    .name("string")
    .enableConsoleOutput(false)
    .pipeExecutionPaused(false)
    .replaceInvalidCharacters(false)
    .quotedIdentifiersIgnoreCase(false)
    .externalVolume("string")
    .isTransient("string")
    .logLevel("string")
    .maxDataExtensionTimeInDays(0)
    .catalog("string")
    .comment("string")
    .dataRetentionTimeInDays(0)
    .defaultDdlCollation("string")
    .storageSerializationPolicy("string")
    .suspendTaskAfterNumFailures(0)
    .taskAutoRetryAttempts(0)
    .traceLevel("string")
    .userTaskManagedInitialWarehouseSize("string")
    .userTaskMinimumTriggerIntervalInSeconds(0)
    .userTaskTimeoutMs(0)
    .withManagedAccess("string")
    .build());

schema_resource = snowflake.Schema("schemaResource",
    database="string",
    name="string",
    enable_console_output=False,
    pipe_execution_paused=False,
    replace_invalid_characters=False,
    quoted_identifiers_ignore_case=False,
    external_volume="string",
    is_transient="string",
    log_level="string",
    max_data_extension_time_in_days=0,
    catalog="string",
    comment="string",
    data_retention_time_in_days=0,
    default_ddl_collation="string",
    storage_serialization_policy="string",
    suspend_task_after_num_failures=0,
    task_auto_retry_attempts=0,
    trace_level="string",
    user_task_managed_initial_warehouse_size="string",
    user_task_minimum_trigger_interval_in_seconds=0,
    user_task_timeout_ms=0,
    with_managed_access="string")

const schemaResource = new snowflake.Schema("schemaResource", {
    database: "string",
    name: "string",
    enableConsoleOutput: false,
    pipeExecutionPaused: false,
    replaceInvalidCharacters: false,
    quotedIdentifiersIgnoreCase: false,
    externalVolume: "string",
    isTransient: "string",
    logLevel: "string",
    maxDataExtensionTimeInDays: 0,
    catalog: "string",
    comment: "string",
    dataRetentionTimeInDays: 0,
    defaultDdlCollation: "string",
    storageSerializationPolicy: "string",
    suspendTaskAfterNumFailures: 0,
    taskAutoRetryAttempts: 0,
    traceLevel: "string",
    userTaskManagedInitialWarehouseSize: "string",
    userTaskMinimumTriggerIntervalInSeconds: 0,
    userTaskTimeoutMs: 0,
    withManagedAccess: "string",
});

type: snowflake:Schema
properties:
    catalog: string
    comment: string
    dataRetentionTimeInDays: 0
    database: string
    defaultDdlCollation: string
    enableConsoleOutput: false
    externalVolume: string
    isTransient: string
    logLevel: string
    maxDataExtensionTimeInDays: 0
    name: string
    pipeExecutionPaused: false
    quotedIdentifiersIgnoreCase: false
    replaceInvalidCharacters: false
    storageSerializationPolicy: string
    suspendTaskAfterNumFailures: 0
    taskAutoRetryAttempts: 0
    traceLevel: string
    userTaskManagedInitialWarehouseSize: string
    userTaskMinimumTriggerIntervalInSeconds: 0
    userTaskTimeoutMs: 0
    withManagedAccess: string

Schema Resource Properties

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

Inputs

The Schema resource accepts the following input properties:

Database string: The database in which to create the schema.
Catalog string: The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
Comment string: Specifies a comment for the schema.
DataRetentionTimeInDays int: Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
DefaultDdlCollation string: Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
EnableConsoleOutput bool: If true, enables stdout/stderr fast path logging for anonymous stored procedures.
ExternalVolume string: The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
IsTransient string: Specifies the schema as transient. Transient schemas do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss. 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.
LogLevel string: Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
MaxDataExtensionTimeInDays int: Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
Name string: Specifies the identifier for the schema; must be unique for the database in which the schema is created. When the name is PUBLIC, during creation the provider checks if this schema has already been created and, in such case, ALTER is used to match the desired state.
PipeExecutionPaused bool: Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role. For more information, check PIPEEXECUTIONPAUSED docs.
QuotedIdentifiersIgnoreCase bool: If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
ReplaceInvalidCharacters bool: Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
StorageSerializationPolicy string: The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
SuspendTaskAfterNumFailures int: How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
TaskAutoRetryAttempts int: Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
TraceLevel string: Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
UserTaskManagedInitialWarehouseSize string: The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
UserTaskMinimumTriggerIntervalInSeconds int: Minimum amount of time between Triggered Task executions in seconds.
UserTaskTimeoutMs int: User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
WithManagedAccess string: Specifies a managed schema. Managed access schemas centralize privilege management with the schema owner. 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.

Database string: The database in which to create the schema.
Catalog string: The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
Comment string: Specifies a comment for the schema.
DataRetentionTimeInDays int: Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
DefaultDdlCollation string: Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
EnableConsoleOutput bool: If true, enables stdout/stderr fast path logging for anonymous stored procedures.
ExternalVolume string: The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
IsTransient string: Specifies the schema as transient. Transient schemas do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss. 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.
LogLevel string: Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
MaxDataExtensionTimeInDays int: Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
Name string: Specifies the identifier for the schema; must be unique for the database in which the schema is created. When the name is PUBLIC, during creation the provider checks if this schema has already been created and, in such case, ALTER is used to match the desired state.
PipeExecutionPaused bool: Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role. For more information, check PIPEEXECUTIONPAUSED docs.
QuotedIdentifiersIgnoreCase bool: If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
ReplaceInvalidCharacters bool: Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
StorageSerializationPolicy string: The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
SuspendTaskAfterNumFailures int: How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
TaskAutoRetryAttempts int: Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
TraceLevel string: Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
UserTaskManagedInitialWarehouseSize string: The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
UserTaskMinimumTriggerIntervalInSeconds int: Minimum amount of time between Triggered Task executions in seconds.
UserTaskTimeoutMs int: User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
WithManagedAccess string: Specifies a managed schema. Managed access schemas centralize privilege management with the schema owner. 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.

database String: The database in which to create the schema.
catalog String: The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
comment String: Specifies a comment for the schema.
dataRetentionTimeInDays Integer: Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
defaultDdlCollation String: Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
enableConsoleOutput Boolean: If true, enables stdout/stderr fast path logging for anonymous stored procedures.
externalVolume String: The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
isTransient String: Specifies the schema as transient. Transient schemas do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss. 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.
logLevel String: Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
maxDataExtensionTimeInDays Integer: Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
name String: Specifies the identifier for the schema; must be unique for the database in which the schema is created. When the name is PUBLIC, during creation the provider checks if this schema has already been created and, in such case, ALTER is used to match the desired state.
pipeExecutionPaused Boolean: Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role. For more information, check PIPEEXECUTIONPAUSED docs.
quotedIdentifiersIgnoreCase Boolean: If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
replaceInvalidCharacters Boolean: Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
storageSerializationPolicy String: The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
suspendTaskAfterNumFailures Integer: How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
taskAutoRetryAttempts Integer: Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
traceLevel String: Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
userTaskManagedInitialWarehouseSize String: The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
userTaskMinimumTriggerIntervalInSeconds Integer: Minimum amount of time between Triggered Task executions in seconds.
userTaskTimeoutMs Integer: User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
withManagedAccess String: Specifies a managed schema. Managed access schemas centralize privilege management with the schema owner. 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.

database string: The database in which to create the schema.
catalog string: The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
comment string: Specifies a comment for the schema.
dataRetentionTimeInDays number: Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
defaultDdlCollation string: Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
enableConsoleOutput boolean: If true, enables stdout/stderr fast path logging for anonymous stored procedures.
externalVolume string: The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
isTransient string: Specifies the schema as transient. Transient schemas do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss. 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.
logLevel string: Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
maxDataExtensionTimeInDays number: Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
name string: Specifies the identifier for the schema; must be unique for the database in which the schema is created. When the name is PUBLIC, during creation the provider checks if this schema has already been created and, in such case, ALTER is used to match the desired state.
pipeExecutionPaused boolean: Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role. For more information, check PIPEEXECUTIONPAUSED docs.
quotedIdentifiersIgnoreCase boolean: If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
replaceInvalidCharacters boolean: Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
storageSerializationPolicy string: The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
suspendTaskAfterNumFailures number: How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
taskAutoRetryAttempts number: Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
traceLevel string: Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
userTaskManagedInitialWarehouseSize string: The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
userTaskMinimumTriggerIntervalInSeconds number: Minimum amount of time between Triggered Task executions in seconds.
userTaskTimeoutMs number: User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
withManagedAccess string: Specifies a managed schema. Managed access schemas centralize privilege management with the schema owner. 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.

database str: The database in which to create the schema.
catalog str: The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
comment str: Specifies a comment for the schema.
data_retention_time_in_days int: Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
default_ddl_collation str: Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
enable_console_output bool: If true, enables stdout/stderr fast path logging for anonymous stored procedures.
external_volume str: The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
is_transient str: Specifies the schema as transient. Transient schemas do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss. 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.
log_level str: Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
max_data_extension_time_in_days int: Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
name str: Specifies the identifier for the schema; must be unique for the database in which the schema is created. When the name is PUBLIC, during creation the provider checks if this schema has already been created and, in such case, ALTER is used to match the desired state.
pipe_execution_paused bool: Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role. For more information, check PIPEEXECUTIONPAUSED docs.
quoted_identifiers_ignore_case bool: If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
replace_invalid_characters bool: Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
storage_serialization_policy str: The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
suspend_task_after_num_failures int: How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
task_auto_retry_attempts int: Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
trace_level str: Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
user_task_managed_initial_warehouse_size str: The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
user_task_minimum_trigger_interval_in_seconds int: Minimum amount of time between Triggered Task executions in seconds.
user_task_timeout_ms int: User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
with_managed_access str: Specifies a managed schema. Managed access schemas centralize privilege management with the schema owner. 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.

database String: The database in which to create the schema.
catalog String: The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
comment String: Specifies a comment for the schema.
dataRetentionTimeInDays Number: Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
defaultDdlCollation String: Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
enableConsoleOutput Boolean: If true, enables stdout/stderr fast path logging for anonymous stored procedures.
externalVolume String: The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
isTransient String: Specifies the schema as transient. Transient schemas do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss. 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.
logLevel String: Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
maxDataExtensionTimeInDays Number: Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
name String: Specifies the identifier for the schema; must be unique for the database in which the schema is created. When the name is PUBLIC, during creation the provider checks if this schema has already been created and, in such case, ALTER is used to match the desired state.
pipeExecutionPaused Boolean: Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role. For more information, check PIPEEXECUTIONPAUSED docs.
quotedIdentifiersIgnoreCase Boolean: If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
replaceInvalidCharacters Boolean: Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
storageSerializationPolicy String: The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
suspendTaskAfterNumFailures Number: How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
taskAutoRetryAttempts Number: Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
traceLevel String: Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
userTaskManagedInitialWarehouseSize String: The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
userTaskMinimumTriggerIntervalInSeconds Number: Minimum amount of time between Triggered Task executions in seconds.
userTaskTimeoutMs Number: User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
withManagedAccess String: Specifies a managed schema. Managed access schemas centralize privilege management with the schema owner. 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.

Outputs

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

DescribeOutputs List<SchemaDescribeOutput>: Outputs the result of DESCRIBE SCHEMA for the given object. In order to handle this output, one must grant sufficient privileges, e.g. grant*ownership on all objects in the schema.
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<SchemaParameter>: Outputs the result of SHOW PARAMETERS IN SCHEMA for the given object.
ShowOutputs List<SchemaShowOutput>: Outputs the result of SHOW SCHEMA for the given object.

DescribeOutputs []SchemaDescribeOutput: Outputs the result of DESCRIBE SCHEMA for the given object. In order to handle this output, one must grant sufficient privileges, e.g. grant*ownership on all objects in the schema.
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 []SchemaParameter: Outputs the result of SHOW PARAMETERS IN SCHEMA for the given object.
ShowOutputs []SchemaShowOutput: Outputs the result of SHOW SCHEMA for the given object.

describeOutputs List<SchemaDescribeOutput>: Outputs the result of DESCRIBE SCHEMA for the given object. In order to handle this output, one must grant sufficient privileges, e.g. grant*ownership on all objects in the schema.
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<SchemaParameter>: Outputs the result of SHOW PARAMETERS IN SCHEMA for the given object.
showOutputs List<SchemaShowOutput>: Outputs the result of SHOW SCHEMA for the given object.

describeOutputs SchemaDescribeOutput[]: Outputs the result of DESCRIBE SCHEMA for the given object. In order to handle this output, one must grant sufficient privileges, e.g. grant*ownership on all objects in the schema.
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 SchemaParameter[]: Outputs the result of SHOW PARAMETERS IN SCHEMA for the given object.
showOutputs SchemaShowOutput[]: Outputs the result of SHOW SCHEMA for the given object.

describe_outputs Sequence[SchemaDescribeOutput]: Outputs the result of DESCRIBE SCHEMA for the given object. In order to handle this output, one must grant sufficient privileges, e.g. grant*ownership on all objects in the schema.
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[SchemaParameter]: Outputs the result of SHOW PARAMETERS IN SCHEMA for the given object.
show_outputs Sequence[SchemaShowOutput]: Outputs the result of SHOW SCHEMA for the given object.

describeOutputs List<Property Map>: Outputs the result of DESCRIBE SCHEMA for the given object. In order to handle this output, one must grant sufficient privileges, e.g. grant*ownership on all objects in the schema.
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 SCHEMA for the given object.
showOutputs List<Property Map>: Outputs the result of SHOW SCHEMA for the given object.

Look up Existing Schema Resource

Get an existing Schema 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?: SchemaState, opts?: CustomResourceOptions): Schema

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog: Optional[str] = None,
        comment: Optional[str] = None,
        data_retention_time_in_days: Optional[int] = None,
        database: Optional[str] = None,
        default_ddl_collation: Optional[str] = None,
        describe_outputs: Optional[Sequence[SchemaDescribeOutputArgs]] = None,
        enable_console_output: Optional[bool] = None,
        external_volume: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        is_transient: Optional[str] = None,
        log_level: Optional[str] = None,
        max_data_extension_time_in_days: Optional[int] = None,
        name: Optional[str] = None,
        parameters: Optional[Sequence[SchemaParameterArgs]] = None,
        pipe_execution_paused: Optional[bool] = None,
        quoted_identifiers_ignore_case: Optional[bool] = None,
        replace_invalid_characters: Optional[bool] = None,
        show_outputs: Optional[Sequence[SchemaShowOutputArgs]] = None,
        storage_serialization_policy: Optional[str] = None,
        suspend_task_after_num_failures: Optional[int] = None,
        task_auto_retry_attempts: Optional[int] = None,
        trace_level: Optional[str] = None,
        user_task_managed_initial_warehouse_size: Optional[str] = None,
        user_task_minimum_trigger_interval_in_seconds: Optional[int] = None,
        user_task_timeout_ms: Optional[int] = None,
        with_managed_access: Optional[str] = None) -> Schema

func GetSchema(ctx *Context, name string, id IDInput, state *SchemaState, opts ...ResourceOption) (*Schema, error)

public static Schema Get(string name, Input<string> id, SchemaState? state, CustomResourceOptions? opts = null)

public static Schema get(String name, Output<String> id, SchemaState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Catalog string: The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
Comment string: Specifies a comment for the schema.
DataRetentionTimeInDays int: Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
Database string: The database in which to create the schema.
DefaultDdlCollation string: Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
DescribeOutputs List<SchemaDescribeOutput>: Outputs the result of DESCRIBE SCHEMA for the given object. In order to handle this output, one must grant sufficient privileges, e.g. grant*ownership on all objects in the schema.
EnableConsoleOutput bool: If true, enables stdout/stderr fast path logging for anonymous stored procedures.
ExternalVolume string: The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
IsTransient string: Specifies the schema as transient. Transient schemas do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss. 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.
LogLevel string: Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
MaxDataExtensionTimeInDays int: Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
Name string: Specifies the identifier for the schema; must be unique for the database in which the schema is created. When the name is PUBLIC, during creation the provider checks if this schema has already been created and, in such case, ALTER is used to match the desired state.
Parameters List<SchemaParameter>: Outputs the result of SHOW PARAMETERS IN SCHEMA for the given object.
PipeExecutionPaused bool: Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role. For more information, check PIPEEXECUTIONPAUSED docs.
QuotedIdentifiersIgnoreCase bool: If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
ReplaceInvalidCharacters bool: Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
ShowOutputs List<SchemaShowOutput>: Outputs the result of SHOW SCHEMA for the given object.
StorageSerializationPolicy string: The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
SuspendTaskAfterNumFailures int: How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
TaskAutoRetryAttempts int: Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
TraceLevel string: Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
UserTaskManagedInitialWarehouseSize string: The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
UserTaskMinimumTriggerIntervalInSeconds int: Minimum amount of time between Triggered Task executions in seconds.
UserTaskTimeoutMs int: User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
WithManagedAccess string: Specifies a managed schema. Managed access schemas centralize privilege management with the schema owner. 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: The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
Comment string: Specifies a comment for the schema.
DataRetentionTimeInDays int: Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
Database string: The database in which to create the schema.
DefaultDdlCollation string: Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
DescribeOutputs []SchemaDescribeOutputArgs: Outputs the result of DESCRIBE SCHEMA for the given object. In order to handle this output, one must grant sufficient privileges, e.g. grant*ownership on all objects in the schema.
EnableConsoleOutput bool: If true, enables stdout/stderr fast path logging for anonymous stored procedures.
ExternalVolume string: The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
IsTransient string: Specifies the schema as transient. Transient schemas do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss. 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.
LogLevel string: Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
MaxDataExtensionTimeInDays int: Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
Name string: Specifies the identifier for the schema; must be unique for the database in which the schema is created. When the name is PUBLIC, during creation the provider checks if this schema has already been created and, in such case, ALTER is used to match the desired state.
Parameters []SchemaParameterArgs: Outputs the result of SHOW PARAMETERS IN SCHEMA for the given object.
PipeExecutionPaused bool: Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role. For more information, check PIPEEXECUTIONPAUSED docs.
QuotedIdentifiersIgnoreCase bool: If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
ReplaceInvalidCharacters bool: Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
ShowOutputs []SchemaShowOutputArgs: Outputs the result of SHOW SCHEMA for the given object.
StorageSerializationPolicy string: The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
SuspendTaskAfterNumFailures int: How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
TaskAutoRetryAttempts int: Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
TraceLevel string: Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
UserTaskManagedInitialWarehouseSize string: The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
UserTaskMinimumTriggerIntervalInSeconds int: Minimum amount of time between Triggered Task executions in seconds.
UserTaskTimeoutMs int: User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
WithManagedAccess string: Specifies a managed schema. Managed access schemas centralize privilege management with the schema owner. 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: The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
comment String: Specifies a comment for the schema.
dataRetentionTimeInDays Integer: Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
database String: The database in which to create the schema.
defaultDdlCollation String: Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
describeOutputs List<SchemaDescribeOutput>: Outputs the result of DESCRIBE SCHEMA for the given object. In order to handle this output, one must grant sufficient privileges, e.g. grant*ownership on all objects in the schema.
enableConsoleOutput Boolean: If true, enables stdout/stderr fast path logging for anonymous stored procedures.
externalVolume String: The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
isTransient String: Specifies the schema as transient. Transient schemas do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss. 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.
logLevel String: Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
maxDataExtensionTimeInDays Integer: Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
name String: Specifies the identifier for the schema; must be unique for the database in which the schema is created. When the name is PUBLIC, during creation the provider checks if this schema has already been created and, in such case, ALTER is used to match the desired state.
parameters List<SchemaParameter>: Outputs the result of SHOW PARAMETERS IN SCHEMA for the given object.
pipeExecutionPaused Boolean: Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role. For more information, check PIPEEXECUTIONPAUSED docs.
quotedIdentifiersIgnoreCase Boolean: If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
replaceInvalidCharacters Boolean: Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
showOutputs List<SchemaShowOutput>: Outputs the result of SHOW SCHEMA for the given object.
storageSerializationPolicy String: The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
suspendTaskAfterNumFailures Integer: How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
taskAutoRetryAttempts Integer: Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
traceLevel String: Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
userTaskManagedInitialWarehouseSize String: The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
userTaskMinimumTriggerIntervalInSeconds Integer: Minimum amount of time between Triggered Task executions in seconds.
userTaskTimeoutMs Integer: User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
withManagedAccess String: Specifies a managed schema. Managed access schemas centralize privilege management with the schema owner. 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: The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
comment string: Specifies a comment for the schema.
dataRetentionTimeInDays number: Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
database string: The database in which to create the schema.
defaultDdlCollation string: Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
describeOutputs SchemaDescribeOutput[]: Outputs the result of DESCRIBE SCHEMA for the given object. In order to handle this output, one must grant sufficient privileges, e.g. grant*ownership on all objects in the schema.
enableConsoleOutput boolean: If true, enables stdout/stderr fast path logging for anonymous stored procedures.
externalVolume string: The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
isTransient string: Specifies the schema as transient. Transient schemas do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss. 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.
logLevel string: Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
maxDataExtensionTimeInDays number: Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
name string: Specifies the identifier for the schema; must be unique for the database in which the schema is created. When the name is PUBLIC, during creation the provider checks if this schema has already been created and, in such case, ALTER is used to match the desired state.
parameters SchemaParameter[]: Outputs the result of SHOW PARAMETERS IN SCHEMA for the given object.
pipeExecutionPaused boolean: Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role. For more information, check PIPEEXECUTIONPAUSED docs.
quotedIdentifiersIgnoreCase boolean: If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
replaceInvalidCharacters boolean: Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
showOutputs SchemaShowOutput[]: Outputs the result of SHOW SCHEMA for the given object.
storageSerializationPolicy string: The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
suspendTaskAfterNumFailures number: How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
taskAutoRetryAttempts number: Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
traceLevel string: Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
userTaskManagedInitialWarehouseSize string: The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
userTaskMinimumTriggerIntervalInSeconds number: Minimum amount of time between Triggered Task executions in seconds.
userTaskTimeoutMs number: User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
withManagedAccess string: Specifies a managed schema. Managed access schemas centralize privilege management with the schema owner. 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: The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
comment str: Specifies a comment for the schema.
data_retention_time_in_days int: Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
database str: The database in which to create the schema.
default_ddl_collation str: Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
describe_outputs Sequence[SchemaDescribeOutputArgs]: Outputs the result of DESCRIBE SCHEMA for the given object. In order to handle this output, one must grant sufficient privileges, e.g. grant*ownership on all objects in the schema.
enable_console_output bool: If true, enables stdout/stderr fast path logging for anonymous stored procedures.
external_volume str: The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
is_transient str: Specifies the schema as transient. Transient schemas do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss. 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.
log_level str: Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
max_data_extension_time_in_days int: Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
name str: Specifies the identifier for the schema; must be unique for the database in which the schema is created. When the name is PUBLIC, during creation the provider checks if this schema has already been created and, in such case, ALTER is used to match the desired state.
parameters Sequence[SchemaParameterArgs]: Outputs the result of SHOW PARAMETERS IN SCHEMA for the given object.
pipe_execution_paused bool: Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role. For more information, check PIPEEXECUTIONPAUSED docs.
quoted_identifiers_ignore_case bool: If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
replace_invalid_characters bool: Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
show_outputs Sequence[SchemaShowOutputArgs]: Outputs the result of SHOW SCHEMA for the given object.
storage_serialization_policy str: The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
suspend_task_after_num_failures int: How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
task_auto_retry_attempts int: Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
trace_level str: Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
user_task_managed_initial_warehouse_size str: The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
user_task_minimum_trigger_interval_in_seconds int: Minimum amount of time between Triggered Task executions in seconds.
user_task_timeout_ms int: User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
with_managed_access str: Specifies a managed schema. Managed access schemas centralize privilege management with the schema owner. 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: The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
comment String: Specifies a comment for the schema.
dataRetentionTimeInDays Number: Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
database String: The database in which to create the schema.
defaultDdlCollation String: Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
describeOutputs List<Property Map>: Outputs the result of DESCRIBE SCHEMA for the given object. In order to handle this output, one must grant sufficient privileges, e.g. grant*ownership on all objects in the schema.
enableConsoleOutput Boolean: If true, enables stdout/stderr fast path logging for anonymous stored procedures.
externalVolume String: The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
isTransient String: Specifies the schema as transient. Transient schemas do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss. 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.
logLevel String: Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
maxDataExtensionTimeInDays Number: Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
name String: Specifies the identifier for the schema; must be unique for the database in which the schema is created. When the name is PUBLIC, during creation the provider checks if this schema has already been created and, in such case, ALTER is used to match the desired state.
parameters List<Property Map>: Outputs the result of SHOW PARAMETERS IN SCHEMA for the given object.
pipeExecutionPaused Boolean: Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role. For more information, check PIPEEXECUTIONPAUSED docs.
quotedIdentifiersIgnoreCase Boolean: If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
replaceInvalidCharacters Boolean: Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
showOutputs List<Property Map>: Outputs the result of SHOW SCHEMA for the given object.
storageSerializationPolicy String: The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
suspendTaskAfterNumFailures Number: How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
taskAutoRetryAttempts Number: Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
traceLevel String: Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
userTaskManagedInitialWarehouseSize String: The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
userTaskMinimumTriggerIntervalInSeconds Number: Minimum amount of time between Triggered Task executions in seconds.
userTaskTimeoutMs Number: User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
withManagedAccess String: Specifies a managed schema. Managed access schemas centralize privilege management with the schema owner. 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.