published on Friday, Nov 6, 2026 by Pulumi
published on Friday, Nov 6, 2026 by Pulumi
Note The provider does not detect external changes on database type. In this case, remove the database of wrong type manually with
terraform destroyand recreate the resource. It will be addressed in the future.
Note A database cannot be dropped successfully if it contains network rule-network policy associations. The error looks like
098507 (2BP01): Cannot drop database DATABASE as it includes network rule - policy associations.. Currently, the provider does not unassign such objects automatically. Before dropping the resource, first unassign the network rule from the relevant objects. See guide for more details.
Note The snowflake.SecondaryDatabase resource doesn’t refresh itself, as the best practice is to use tasks scheduled for a certain interval. Check out the examples to see how to set up the refresh task. For SQL-based replication guide, see the official documentation.
A secondary database creates a replica of an existing primary database (i.e. a secondary database). For more information about database replication, see Introduction to database replication across multiple accounts.
Create SecondaryDatabase Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SecondaryDatabase(name: string, args: SecondaryDatabaseArgs, opts?: CustomResourceOptions);@overload
def SecondaryDatabase(resource_name: str,
args: SecondaryDatabaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SecondaryDatabase(resource_name: str,
opts: Optional[ResourceOptions] = None,
as_replica_of: Optional[str] = None,
catalog: Optional[str] = None,
comment: Optional[str] = None,
data_retention_time_in_days: Optional[int] = None,
default_ddl_collation: Optional[str] = None,
default_notebook_compute_pool_cpu: Optional[str] = None,
default_notebook_compute_pool_gpu: Optional[str] = None,
enable_console_output: Optional[bool] = None,
external_volume: Optional[str] = None,
is_transient: Optional[bool] = None,
log_event_level: Optional[str] = None,
log_level: Optional[str] = None,
max_data_extension_time_in_days: Optional[int] = None,
name: Optional[str] = None,
quoted_identifiers_ignore_case: Optional[bool] = None,
replace_invalid_characters: Optional[bool] = 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)func NewSecondaryDatabase(ctx *Context, name string, args SecondaryDatabaseArgs, opts ...ResourceOption) (*SecondaryDatabase, error)public SecondaryDatabase(string name, SecondaryDatabaseArgs args, CustomResourceOptions? opts = null)
public SecondaryDatabase(String name, SecondaryDatabaseArgs args)
public SecondaryDatabase(String name, SecondaryDatabaseArgs args, CustomResourceOptions options)
type: snowflake:SecondaryDatabase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "snowflake_secondary_database" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args SecondaryDatabaseArgs
- 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 SecondaryDatabaseArgs
- 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 SecondaryDatabaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SecondaryDatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SecondaryDatabaseArgs
- 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 secondaryDatabaseResource = new Snowflake.SecondaryDatabase("secondaryDatabaseResource", new()
{
AsReplicaOf = "string",
Catalog = "string",
Comment = "string",
DataRetentionTimeInDays = 0,
DefaultDdlCollation = "string",
DefaultNotebookComputePoolCpu = "string",
DefaultNotebookComputePoolGpu = "string",
EnableConsoleOutput = false,
ExternalVolume = "string",
IsTransient = false,
LogEventLevel = "string",
LogLevel = "string",
MaxDataExtensionTimeInDays = 0,
Name = "string",
QuotedIdentifiersIgnoreCase = false,
ReplaceInvalidCharacters = false,
StorageSerializationPolicy = "string",
SuspendTaskAfterNumFailures = 0,
TaskAutoRetryAttempts = 0,
TraceLevel = "string",
UserTaskManagedInitialWarehouseSize = "string",
UserTaskMinimumTriggerIntervalInSeconds = 0,
UserTaskTimeoutMs = 0,
});
example, err := snowflake.NewSecondaryDatabase(ctx, "secondaryDatabaseResource", &snowflake.SecondaryDatabaseArgs{
AsReplicaOf: pulumi.String("string"),
Catalog: pulumi.String("string"),
Comment: pulumi.String("string"),
DataRetentionTimeInDays: pulumi.Int(0),
DefaultDdlCollation: pulumi.String("string"),
DefaultNotebookComputePoolCpu: pulumi.String("string"),
DefaultNotebookComputePoolGpu: pulumi.String("string"),
EnableConsoleOutput: pulumi.Bool(false),
ExternalVolume: pulumi.String("string"),
IsTransient: pulumi.Bool(false),
LogEventLevel: pulumi.String("string"),
LogLevel: pulumi.String("string"),
MaxDataExtensionTimeInDays: pulumi.Int(0),
Name: pulumi.String("string"),
QuotedIdentifiersIgnoreCase: pulumi.Bool(false),
ReplaceInvalidCharacters: pulumi.Bool(false),
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),
})
resource "snowflake_secondary_database" "secondaryDatabaseResource" {
lifecycle {
create_before_destroy = true
}
as_replica_of = "string"
catalog = "string"
comment = "string"
data_retention_time_in_days = 0
default_ddl_collation = "string"
default_notebook_compute_pool_cpu = "string"
default_notebook_compute_pool_gpu = "string"
enable_console_output = false
external_volume = "string"
is_transient = false
log_event_level = "string"
log_level = "string"
max_data_extension_time_in_days = 0
name = "string"
quoted_identifiers_ignore_case = false
replace_invalid_characters = false
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
}
var secondaryDatabaseResource = new SecondaryDatabase("secondaryDatabaseResource", SecondaryDatabaseArgs.builder()
.asReplicaOf("string")
.catalog("string")
.comment("string")
.dataRetentionTimeInDays(0)
.defaultDdlCollation("string")
.defaultNotebookComputePoolCpu("string")
.defaultNotebookComputePoolGpu("string")
.enableConsoleOutput(false)
.externalVolume("string")
.isTransient(false)
.logEventLevel("string")
.logLevel("string")
.maxDataExtensionTimeInDays(0)
.name("string")
.quotedIdentifiersIgnoreCase(false)
.replaceInvalidCharacters(false)
.storageSerializationPolicy("string")
.suspendTaskAfterNumFailures(0)
.taskAutoRetryAttempts(0)
.traceLevel("string")
.userTaskManagedInitialWarehouseSize("string")
.userTaskMinimumTriggerIntervalInSeconds(0)
.userTaskTimeoutMs(0)
.build());
secondary_database_resource = snowflake.SecondaryDatabase("secondaryDatabaseResource",
as_replica_of="string",
catalog="string",
comment="string",
data_retention_time_in_days=0,
default_ddl_collation="string",
default_notebook_compute_pool_cpu="string",
default_notebook_compute_pool_gpu="string",
enable_console_output=False,
external_volume="string",
is_transient=False,
log_event_level="string",
log_level="string",
max_data_extension_time_in_days=0,
name="string",
quoted_identifiers_ignore_case=False,
replace_invalid_characters=False,
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)
const secondaryDatabaseResource = new snowflake.SecondaryDatabase("secondaryDatabaseResource", {
asReplicaOf: "string",
catalog: "string",
comment: "string",
dataRetentionTimeInDays: 0,
defaultDdlCollation: "string",
defaultNotebookComputePoolCpu: "string",
defaultNotebookComputePoolGpu: "string",
enableConsoleOutput: false,
externalVolume: "string",
isTransient: false,
logEventLevel: "string",
logLevel: "string",
maxDataExtensionTimeInDays: 0,
name: "string",
quotedIdentifiersIgnoreCase: false,
replaceInvalidCharacters: false,
storageSerializationPolicy: "string",
suspendTaskAfterNumFailures: 0,
taskAutoRetryAttempts: 0,
traceLevel: "string",
userTaskManagedInitialWarehouseSize: "string",
userTaskMinimumTriggerIntervalInSeconds: 0,
userTaskTimeoutMs: 0,
});
type: snowflake:SecondaryDatabase
properties:
asReplicaOf: string
catalog: string
comment: string
dataRetentionTimeInDays: 0
defaultDdlCollation: string
defaultNotebookComputePoolCpu: string
defaultNotebookComputePoolGpu: string
enableConsoleOutput: false
externalVolume: string
isTransient: false
logEventLevel: string
logLevel: string
maxDataExtensionTimeInDays: 0
name: string
quotedIdentifiersIgnoreCase: false
replaceInvalidCharacters: false
storageSerializationPolicy: string
suspendTaskAfterNumFailures: 0
taskAutoRetryAttempts: 0
traceLevel: string
userTaskManagedInitialWarehouseSize: string
userTaskMinimumTriggerIntervalInSeconds: 0
userTaskTimeoutMs: 0
SecondaryDatabase 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 SecondaryDatabase resource accepts the following input properties:
- As
Replica stringOf - A fully qualified path to a database to create a replica from. A fully qualified path follows the format of
"<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs. - Catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- Comment string
- Specifies a comment for the database.
- Data
Retention intTime In Days - 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. For more information, check DATARETENTIONTIMEINDAYS docs.
- Default
Ddl stringCollation - 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. For more information, check DEFAULTDDLCOLLATION docs.
- Default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- Default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- Enable
Console boolOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- External
Volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- Is
Transient bool - Specifies the database as transient. Transient databases 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.
- Log
Event stringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - Log
Level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - Max
Data intExtension Time In Days - 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 more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- Name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Quoted
Identifiers boolIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- Replace
Invalid boolCharacters - 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, check REPLACEINVALIDCHARACTERS docs.
- Storage
Serialization stringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. 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. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - Suspend
Task intAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- Task
Auto intRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- Trace
Level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - User
Task stringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - User
Task intMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- User
Task intTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- As
Replica stringOf - A fully qualified path to a database to create a replica from. A fully qualified path follows the format of
"<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs. - Catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- Comment string
- Specifies a comment for the database.
- Data
Retention intTime In Days - 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. For more information, check DATARETENTIONTIMEINDAYS docs.
- Default
Ddl stringCollation - 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. For more information, check DEFAULTDDLCOLLATION docs.
- Default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- Default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- Enable
Console boolOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- External
Volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- Is
Transient bool - Specifies the database as transient. Transient databases 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.
- Log
Event stringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - Log
Level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - Max
Data intExtension Time In Days - 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 more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- Name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Quoted
Identifiers boolIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- Replace
Invalid boolCharacters - 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, check REPLACEINVALIDCHARACTERS docs.
- Storage
Serialization stringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. 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. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - Suspend
Task intAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- Task
Auto intRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- Trace
Level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - User
Task stringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - User
Task intMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- User
Task intTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- as_
replica_ stringof - A fully qualified path to a database to create a replica from. A fully qualified path follows the format of
"<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs. - catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment string
- Specifies a comment for the database.
- data_
retention_ numbertime_ in_ days - 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. For more information, check DATARETENTIONTIMEINDAYS docs.
- default_
ddl_ stringcollation - 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. For more information, check DEFAULTDDLCOLLATION docs.
- default_
notebook_ stringcompute_ pool_ cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default_
notebook_ stringcompute_ pool_ gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- enable_
console_ booloutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external_
volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- is_
transient bool - Specifies the database as transient. Transient databases 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.
- log_
event_ stringlevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log_
level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max_
data_ numberextension_ time_ in_ days - 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 more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted_
identifiers_ boolignore_ case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace_
invalid_ boolcharacters - 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, check REPLACEINVALIDCHARACTERS docs.
- storage_
serialization_ stringpolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. 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. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend_
task_ numberafter_ num_ failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task_
auto_ numberretry_ attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace_
level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user_
task_ stringmanaged_ initial_ warehouse_ size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user_
task_ numberminimum_ trigger_ interval_ in_ seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user_
task_ numbertimeout_ ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- as
Replica StringOf - A fully qualified path to a database to create a replica from. A fully qualified path follows the format of
"<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs. - catalog String
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment String
- Specifies a comment for the database.
- data
Retention IntegerTime In Days - 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. For more information, check DATARETENTIONTIMEINDAYS docs.
- default
Ddl StringCollation - 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. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook StringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default
Notebook StringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- enable
Console BooleanOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external
Volume String - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- is
Transient Boolean - Specifies the database as transient. Transient databases 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.
- log
Event StringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log
Level String - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max
Data IntegerExtension Time In Days - 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 more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name String
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted
Identifiers BooleanIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace
Invalid BooleanCharacters - 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, check REPLACEINVALIDCHARACTERS docs.
- storage
Serialization StringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. 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. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend
Task IntegerAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto IntegerRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace
Level String - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user
Task StringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user
Task IntegerMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user
Task IntegerTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- as
Replica stringOf - A fully qualified path to a database to create a replica from. A fully qualified path follows the format of
"<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs. - catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment string
- Specifies a comment for the database.
- data
Retention numberTime In Days - 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. For more information, check DATARETENTIONTIMEINDAYS docs.
- default
Ddl stringCollation - 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. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- enable
Console booleanOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external
Volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- is
Transient boolean - Specifies the database as transient. Transient databases 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.
- log
Event stringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log
Level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max
Data numberExtension Time In Days - 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 more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted
Identifiers booleanIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace
Invalid booleanCharacters - 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, check REPLACEINVALIDCHARACTERS docs.
- storage
Serialization stringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. 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. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend
Task numberAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto numberRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace
Level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user
Task stringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user
Task numberMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user
Task numberTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- as_
replica_ strof - A fully qualified path to a database to create a replica from. A fully qualified path follows the format of
"<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs. - catalog str
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment str
- Specifies a comment for the database.
- data_
retention_ inttime_ in_ days - 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. For more information, check DATARETENTIONTIMEINDAYS docs.
- default_
ddl_ strcollation - 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. For more information, check DEFAULTDDLCOLLATION docs.
- default_
notebook_ strcompute_ pool_ cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default_
notebook_ strcompute_ pool_ gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- enable_
console_ booloutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external_
volume str - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- is_
transient bool - Specifies the database as transient. Transient databases 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.
- log_
event_ strlevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log_
level str - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max_
data_ intextension_ time_ in_ days - 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 more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name str
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted_
identifiers_ boolignore_ case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace_
invalid_ boolcharacters - 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, check REPLACEINVALIDCHARACTERS docs.
- storage_
serialization_ strpolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. 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. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend_
task_ intafter_ num_ failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task_
auto_ intretry_ attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace_
level str - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user_
task_ strmanaged_ initial_ warehouse_ size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user_
task_ intminimum_ trigger_ interval_ in_ seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user_
task_ inttimeout_ ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- as
Replica StringOf - A fully qualified path to a database to create a replica from. A fully qualified path follows the format of
"<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs. - catalog String
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment String
- Specifies a comment for the database.
- data
Retention NumberTime In Days - 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. For more information, check DATARETENTIONTIMEINDAYS docs.
- default
Ddl StringCollation - 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. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook StringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default
Notebook StringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- enable
Console BooleanOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external
Volume String - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- is
Transient Boolean - Specifies the database as transient. Transient databases 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.
- log
Event StringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log
Level String - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max
Data NumberExtension Time In Days - 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 more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name String
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted
Identifiers BooleanIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace
Invalid BooleanCharacters - 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, check REPLACEINVALIDCHARACTERS docs.
- storage
Serialization StringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. 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. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend
Task NumberAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto NumberRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace
Level String - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user
Task StringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user
Task NumberMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user
Task NumberTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
Outputs
All input properties are implicitly available as output properties. Additionally, the SecondaryDatabase resource produces the following output properties:
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
Look up Existing SecondaryDatabase Resource
Get an existing SecondaryDatabase 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?: SecondaryDatabaseState, opts?: CustomResourceOptions): SecondaryDatabase@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
as_replica_of: Optional[str] = None,
catalog: Optional[str] = None,
comment: Optional[str] = None,
data_retention_time_in_days: Optional[int] = None,
default_ddl_collation: Optional[str] = None,
default_notebook_compute_pool_cpu: Optional[str] = None,
default_notebook_compute_pool_gpu: Optional[str] = None,
enable_console_output: Optional[bool] = None,
external_volume: Optional[str] = None,
fully_qualified_name: Optional[str] = None,
is_transient: Optional[bool] = None,
log_event_level: Optional[str] = None,
log_level: Optional[str] = None,
max_data_extension_time_in_days: Optional[int] = None,
name: Optional[str] = None,
quoted_identifiers_ignore_case: Optional[bool] = None,
replace_invalid_characters: Optional[bool] = 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) -> SecondaryDatabasefunc GetSecondaryDatabase(ctx *Context, name string, id IDInput, state *SecondaryDatabaseState, opts ...ResourceOption) (*SecondaryDatabase, error)public static SecondaryDatabase Get(string name, Input<string> id, SecondaryDatabaseState? state, CustomResourceOptions? opts = null)public static SecondaryDatabase get(String name, Output<String> id, SecondaryDatabaseState state, CustomResourceOptions options)resources: _: type: snowflake:SecondaryDatabase get: id: ${id}import {
to = snowflake_secondary_database.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.
- As
Replica stringOf - A fully qualified path to a database to create a replica from. A fully qualified path follows the format of
"<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs. - Catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- Comment string
- Specifies a comment for the database.
- Data
Retention intTime In Days - 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. For more information, check DATARETENTIONTIMEINDAYS docs.
- Default
Ddl stringCollation - 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. For more information, check DEFAULTDDLCOLLATION docs.
- Default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- Default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- Enable
Console boolOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- External
Volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Is
Transient bool - Specifies the database as transient. Transient databases 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.
- Log
Event stringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - Log
Level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - Max
Data intExtension Time In Days - 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 more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- Name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Quoted
Identifiers boolIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- Replace
Invalid boolCharacters - 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, check REPLACEINVALIDCHARACTERS docs.
- Storage
Serialization stringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. 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. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - Suspend
Task intAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- Task
Auto intRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- Trace
Level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - User
Task stringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - User
Task intMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- User
Task intTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- As
Replica stringOf - A fully qualified path to a database to create a replica from. A fully qualified path follows the format of
"<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs. - Catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- Comment string
- Specifies a comment for the database.
- Data
Retention intTime In Days - 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. For more information, check DATARETENTIONTIMEINDAYS docs.
- Default
Ddl stringCollation - 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. For more information, check DEFAULTDDLCOLLATION docs.
- Default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- Default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- Enable
Console boolOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- External
Volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Is
Transient bool - Specifies the database as transient. Transient databases 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.
- Log
Event stringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - Log
Level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - Max
Data intExtension Time In Days - 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 more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- Name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Quoted
Identifiers boolIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- Replace
Invalid boolCharacters - 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, check REPLACEINVALIDCHARACTERS docs.
- Storage
Serialization stringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. 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. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - Suspend
Task intAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- Task
Auto intRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- Trace
Level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - User
Task stringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - User
Task intMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- User
Task intTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- as_
replica_ stringof - A fully qualified path to a database to create a replica from. A fully qualified path follows the format of
"<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs. - catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment string
- Specifies a comment for the database.
- data_
retention_ numbertime_ in_ days - 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. For more information, check DATARETENTIONTIMEINDAYS docs.
- default_
ddl_ stringcollation - 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. For more information, check DEFAULTDDLCOLLATION docs.
- default_
notebook_ stringcompute_ pool_ cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default_
notebook_ stringcompute_ pool_ gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- enable_
console_ booloutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external_
volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- fully_
qualified_ stringname - Fully qualified name of the resource. For more information, see object name resolution.
- is_
transient bool - Specifies the database as transient. Transient databases 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.
- log_
event_ stringlevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log_
level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max_
data_ numberextension_ time_ in_ days - 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 more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted_
identifiers_ boolignore_ case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace_
invalid_ boolcharacters - 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, check REPLACEINVALIDCHARACTERS docs.
- storage_
serialization_ stringpolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. 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. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend_
task_ numberafter_ num_ failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task_
auto_ numberretry_ attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace_
level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user_
task_ stringmanaged_ initial_ warehouse_ size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user_
task_ numberminimum_ trigger_ interval_ in_ seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user_
task_ numbertimeout_ ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- as
Replica StringOf - A fully qualified path to a database to create a replica from. A fully qualified path follows the format of
"<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs. - catalog String
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment String
- Specifies a comment for the database.
- data
Retention IntegerTime In Days - 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. For more information, check DATARETENTIONTIMEINDAYS docs.
- default
Ddl StringCollation - 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. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook StringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default
Notebook StringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- enable
Console BooleanOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external
Volume String - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- is
Transient Boolean - Specifies the database as transient. Transient databases 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.
- log
Event StringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log
Level String - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max
Data IntegerExtension Time In Days - 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 more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name String
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted
Identifiers BooleanIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace
Invalid BooleanCharacters - 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, check REPLACEINVALIDCHARACTERS docs.
- storage
Serialization StringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. 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. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend
Task IntegerAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto IntegerRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace
Level String - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user
Task StringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user
Task IntegerMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user
Task IntegerTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- as
Replica stringOf - A fully qualified path to a database to create a replica from. A fully qualified path follows the format of
"<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs. - catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment string
- Specifies a comment for the database.
- data
Retention numberTime In Days - 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. For more information, check DATARETENTIONTIMEINDAYS docs.
- default
Ddl stringCollation - 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. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- enable
Console booleanOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external
Volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- is
Transient boolean - Specifies the database as transient. Transient databases 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.
- log
Event stringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log
Level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max
Data numberExtension Time In Days - 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 more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted
Identifiers booleanIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace
Invalid booleanCharacters - 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, check REPLACEINVALIDCHARACTERS docs.
- storage
Serialization stringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. 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. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend
Task numberAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto numberRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace
Level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user
Task stringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user
Task numberMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user
Task numberTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- as_
replica_ strof - A fully qualified path to a database to create a replica from. A fully qualified path follows the format of
"<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs. - catalog str
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment str
- Specifies a comment for the database.
- data_
retention_ inttime_ in_ days - 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. For more information, check DATARETENTIONTIMEINDAYS docs.
- default_
ddl_ strcollation - 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. For more information, check DEFAULTDDLCOLLATION docs.
- default_
notebook_ strcompute_ pool_ cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default_
notebook_ strcompute_ pool_ gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- enable_
console_ booloutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external_
volume str - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- is_
transient bool - Specifies the database as transient. Transient databases 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.
- log_
event_ strlevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log_
level str - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max_
data_ intextension_ time_ in_ days - 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 more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name str
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted_
identifiers_ boolignore_ case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace_
invalid_ boolcharacters - 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, check REPLACEINVALIDCHARACTERS docs.
- storage_
serialization_ strpolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. 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. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend_
task_ intafter_ num_ failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task_
auto_ intretry_ attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace_
level str - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user_
task_ strmanaged_ initial_ warehouse_ size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user_
task_ intminimum_ trigger_ interval_ in_ seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user_
task_ inttimeout_ ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- as
Replica StringOf - A fully qualified path to a database to create a replica from. A fully qualified path follows the format of
"<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs. - catalog String
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment String
- Specifies a comment for the database.
- data
Retention NumberTime In Days - 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. For more information, check DATARETENTIONTIMEINDAYS docs.
- default
Ddl StringCollation - 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. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook StringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default
Notebook StringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- enable
Console BooleanOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external
Volume String - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- is
Transient Boolean - Specifies the database as transient. Transient databases 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.
- log
Event StringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log
Level String - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max
Data NumberExtension Time In Days - 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 more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name String
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted
Identifiers BooleanIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace
Invalid BooleanCharacters - 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, check REPLACEINVALIDCHARACTERS docs.
- storage
Serialization StringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. 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. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend
Task NumberAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto NumberRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace
Level String - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user
Task StringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user
Task NumberMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user
Task NumberTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
Import
Make sure that isTransient is set in your config explicitly before import to avoid diff and recreation
(reasons are presented in this migration guide entry).
$ pulumi import snowflake:index/secondaryDatabase:SecondaryDatabase example '"<secondary_database_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 Friday, Nov 6, 2026 by Pulumi