snowflake.SecondaryDatabase
Explore with Pulumi AI
Import
$ pulumi import snowflake:index/secondaryDatabase:SecondaryDatabase example '"<secondary_database_name>"'
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,
                      enable_console_output: Optional[bool] = None,
                      external_volume: Optional[str] = None,
                      is_transient: Optional[bool] = 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.
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",
    EnableConsoleOutput = false,
    ExternalVolume = "string",
    IsTransient = false,
    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"),
	EnableConsoleOutput:                     pulumi.Bool(false),
	ExternalVolume:                          pulumi.String("string"),
	IsTransient:                             pulumi.Bool(false),
	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),
})
var secondaryDatabaseResource = new SecondaryDatabase("secondaryDatabaseResource", SecondaryDatabaseArgs.builder()
    .asReplicaOf("string")
    .catalog("string")
    .comment("string")
    .dataRetentionTimeInDays(0)
    .defaultDdlCollation("string")
    .enableConsoleOutput(false)
    .externalVolume("string")
    .isTransient(false)
    .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",
    enable_console_output=False,
    external_volume="string",
    is_transient=False,
    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",
    enableConsoleOutput: false,
    externalVolume: "string",
    isTransient: false,
    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
    enableConsoleOutput: false
    externalVolume: string
    isTransient: false
    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:
- AsReplica 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 database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
- Comment string
- Specifies a comment for the database.
- DataRetention 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.
- DefaultDdl 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.
- EnableConsole boolOutput 
- If true, enables stdout/stderr fast path logging for anonymous stored procedures.
- ExternalVolume string
- The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
- IsTransient 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.
- LogLevel string
- Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
- MaxData 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 a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
- 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: |,.,".
- QuotedIdentifiers boolIgnore Case 
- If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
- ReplaceInvalid 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, see REPLACEINVALIDCHARACTERS.
- StorageSerialization stringPolicy 
- The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
- SuspendTask 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, see SUSPENDTASKAFTERNUMFAILURES.
- TaskAuto intRetry Attempts 
- Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
- TraceLevel string
- Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
- UserTask stringManaged Initial Warehouse Size 
- The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
- UserTask intMinimum Trigger Interval In Seconds 
- Minimum amount of time between Triggered Task executions in seconds.
- UserTask intTimeout Ms 
- User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
- AsReplica 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 database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
- Comment string
- Specifies a comment for the database.
- DataRetention 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.
- DefaultDdl 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.
- EnableConsole boolOutput 
- If true, enables stdout/stderr fast path logging for anonymous stored procedures.
- ExternalVolume string
- The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
- IsTransient 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.
- LogLevel string
- Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
- MaxData 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 a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
- 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: |,.,".
- QuotedIdentifiers boolIgnore Case 
- If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
- ReplaceInvalid 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, see REPLACEINVALIDCHARACTERS.
- StorageSerialization stringPolicy 
- The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
- SuspendTask 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, see SUSPENDTASKAFTERNUMFAILURES.
- TaskAuto intRetry Attempts 
- Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
- TraceLevel string
- Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
- UserTask stringManaged Initial Warehouse Size 
- The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
- UserTask intMinimum Trigger Interval In Seconds 
- Minimum amount of time between Triggered Task executions in seconds.
- UserTask intTimeout Ms 
- User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
- asReplica 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 database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
- comment String
- Specifies a comment for the database.
- dataRetention 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.
- defaultDdl 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.
- enableConsole BooleanOutput 
- If true, enables stdout/stderr fast path logging for anonymous stored procedures.
- externalVolume String
- The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
- isTransient 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.
- logLevel String
- Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
- maxData 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 a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
- 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: |,.,".
- quotedIdentifiers BooleanIgnore Case 
- If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
- replaceInvalid 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, see REPLACEINVALIDCHARACTERS.
- storageSerialization StringPolicy 
- The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
- suspendTask 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, see SUSPENDTASKAFTERNUMFAILURES.
- taskAuto IntegerRetry Attempts 
- Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
- traceLevel String
- Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
- userTask StringManaged Initial Warehouse Size 
- The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
- userTask IntegerMinimum Trigger Interval In Seconds 
- Minimum amount of time between Triggered Task executions in seconds.
- userTask IntegerTimeout Ms 
- User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
- asReplica 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 database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
- comment string
- Specifies a comment for the database.
- dataRetention 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.
- defaultDdl 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.
- enableConsole booleanOutput 
- If true, enables stdout/stderr fast path logging for anonymous stored procedures.
- externalVolume string
- The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
- isTransient 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.
- logLevel string
- Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
- maxData 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 a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
- 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: |,.,".
- quotedIdentifiers booleanIgnore Case 
- If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
- replaceInvalid 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, see REPLACEINVALIDCHARACTERS.
- storageSerialization stringPolicy 
- The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
- suspendTask 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, see SUSPENDTASKAFTERNUMFAILURES.
- taskAuto numberRetry Attempts 
- Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
- traceLevel string
- Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
- userTask stringManaged Initial Warehouse Size 
- The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
- userTask numberMinimum Trigger Interval In Seconds 
- Minimum amount of time between Triggered Task executions in seconds.
- userTask numberTimeout Ms 
- User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
- 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 database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
- 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.
- 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.
- enable_console_ booloutput 
- If true, enables stdout/stderr fast path logging for anonymous stored procedures.
- external_volume str
- The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
- is_transient 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_level str
- Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
- max_data_ 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 a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
- 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, see QUOTEDIDENTIFIERSIGNORE_CASE.
- 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, see REPLACEINVALIDCHARACTERS.
- storage_serialization_ strpolicy 
- The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
- suspend_task_ 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, see SUSPENDTASKAFTERNUMFAILURES.
- task_auto_ intretry_ attempts 
- Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
- trace_level str
- Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
- user_task_ strmanaged_ initial_ warehouse_ size 
- The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
- user_task_ intminimum_ trigger_ interval_ in_ seconds 
- Minimum amount of time between Triggered Task executions in seconds.
- user_task_ inttimeout_ ms 
- User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
- asReplica 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 database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
- comment String
- Specifies a comment for the database.
- dataRetention 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.
- defaultDdl 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.
- enableConsole BooleanOutput 
- If true, enables stdout/stderr fast path logging for anonymous stored procedures.
- externalVolume String
- The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
- isTransient 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.
- logLevel String
- Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
- maxData 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 a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
- 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: |,.,".
- quotedIdentifiers BooleanIgnore Case 
- If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
- replaceInvalid 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, see REPLACEINVALIDCHARACTERS.
- storageSerialization StringPolicy 
- The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
- suspendTask 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, see SUSPENDTASKAFTERNUMFAILURES.
- taskAuto NumberRetry Attempts 
- Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
- traceLevel String
- Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
- userTask StringManaged Initial Warehouse Size 
- The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
- userTask NumberMinimum Trigger Interval In Seconds 
- Minimum amount of time between Triggered Task executions in seconds.
- userTask NumberTimeout Ms 
- User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
Outputs
All input properties are implicitly available as output properties. Additionally, the SecondaryDatabase resource produces the following output properties:
- FullyQualified 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.
- FullyQualified 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.
- fullyQualified 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.
- fullyQualified 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.
- fullyQualified 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,
        enable_console_output: Optional[bool] = None,
        external_volume: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        is_transient: Optional[bool] = 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}- 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.
- AsReplica 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 database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
- Comment string
- Specifies a comment for the database.
- DataRetention 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.
- DefaultDdl 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.
- EnableConsole boolOutput 
- If true, enables stdout/stderr fast path logging for anonymous stored procedures.
- ExternalVolume string
- The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
- FullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- IsTransient 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.
- LogLevel string
- Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
- MaxData 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 a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
- 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: |,.,".
- QuotedIdentifiers boolIgnore Case 
- If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
- ReplaceInvalid 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, see REPLACEINVALIDCHARACTERS.
- StorageSerialization stringPolicy 
- The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
- SuspendTask 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, see SUSPENDTASKAFTERNUMFAILURES.
- TaskAuto intRetry Attempts 
- Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
- TraceLevel string
- Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
- UserTask stringManaged Initial Warehouse Size 
- The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
- UserTask intMinimum Trigger Interval In Seconds 
- Minimum amount of time between Triggered Task executions in seconds.
- UserTask intTimeout Ms 
- User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
- AsReplica 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 database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
- Comment string
- Specifies a comment for the database.
- DataRetention 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.
- DefaultDdl 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.
- EnableConsole boolOutput 
- If true, enables stdout/stderr fast path logging for anonymous stored procedures.
- ExternalVolume string
- The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
- FullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- IsTransient 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.
- LogLevel string
- Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
- MaxData 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 a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
- 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: |,.,".
- QuotedIdentifiers boolIgnore Case 
- If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
- ReplaceInvalid 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, see REPLACEINVALIDCHARACTERS.
- StorageSerialization stringPolicy 
- The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
- SuspendTask 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, see SUSPENDTASKAFTERNUMFAILURES.
- TaskAuto intRetry Attempts 
- Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
- TraceLevel string
- Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
- UserTask stringManaged Initial Warehouse Size 
- The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
- UserTask intMinimum Trigger Interval In Seconds 
- Minimum amount of time between Triggered Task executions in seconds.
- UserTask intTimeout Ms 
- User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
- asReplica 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 database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
- comment String
- Specifies a comment for the database.
- dataRetention 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.
- defaultDdl 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.
- enableConsole BooleanOutput 
- If true, enables stdout/stderr fast path logging for anonymous stored procedures.
- externalVolume String
- The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
- fullyQualified StringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- isTransient 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.
- logLevel String
- Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
- maxData 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 a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
- 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: |,.,".
- quotedIdentifiers BooleanIgnore Case 
- If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
- replaceInvalid 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, see REPLACEINVALIDCHARACTERS.
- storageSerialization StringPolicy 
- The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
- suspendTask 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, see SUSPENDTASKAFTERNUMFAILURES.
- taskAuto IntegerRetry Attempts 
- Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
- traceLevel String
- Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
- userTask StringManaged Initial Warehouse Size 
- The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
- userTask IntegerMinimum Trigger Interval In Seconds 
- Minimum amount of time between Triggered Task executions in seconds.
- userTask IntegerTimeout Ms 
- User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
- asReplica 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 database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
- comment string
- Specifies a comment for the database.
- dataRetention 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.
- defaultDdl 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.
- enableConsole booleanOutput 
- If true, enables stdout/stderr fast path logging for anonymous stored procedures.
- externalVolume string
- The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
- fullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- isTransient 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.
- logLevel string
- Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
- maxData 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 a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
- 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: |,.,".
- quotedIdentifiers booleanIgnore Case 
- If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
- replaceInvalid 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, see REPLACEINVALIDCHARACTERS.
- storageSerialization stringPolicy 
- The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
- suspendTask 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, see SUSPENDTASKAFTERNUMFAILURES.
- taskAuto numberRetry Attempts 
- Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
- traceLevel string
- Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
- userTask stringManaged Initial Warehouse Size 
- The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
- userTask numberMinimum Trigger Interval In Seconds 
- Minimum amount of time between Triggered Task executions in seconds.
- userTask numberTimeout Ms 
- User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
- 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 database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
- 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.
- 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.
- enable_console_ booloutput 
- If true, enables stdout/stderr fast path logging for anonymous stored procedures.
- external_volume str
- The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
- fully_qualified_ 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_level str
- Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
- max_data_ 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 a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
- 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, see QUOTEDIDENTIFIERSIGNORE_CASE.
- 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, see REPLACEINVALIDCHARACTERS.
- storage_serialization_ strpolicy 
- The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
- suspend_task_ 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, see SUSPENDTASKAFTERNUMFAILURES.
- task_auto_ intretry_ attempts 
- Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
- trace_level str
- Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
- user_task_ strmanaged_ initial_ warehouse_ size 
- The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
- user_task_ intminimum_ trigger_ interval_ in_ seconds 
- Minimum amount of time between Triggered Task executions in seconds.
- user_task_ inttimeout_ ms 
- User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
- asReplica 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 database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
- comment String
- Specifies a comment for the database.
- dataRetention 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.
- defaultDdl 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.
- enableConsole BooleanOutput 
- If true, enables stdout/stderr fast path logging for anonymous stored procedures.
- externalVolume String
- The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
- fullyQualified StringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- isTransient 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.
- logLevel String
- Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]. Messages at the specified level (and at more severe levels) are ingested. For more information, see LOG_LEVEL.
- maxData 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 a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
- 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: |,.,".
- quotedIdentifiers BooleanIgnore Case 
- If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
- replaceInvalid 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, see REPLACEINVALIDCHARACTERS.
- storageSerialization StringPolicy 
- The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
- suspendTask 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, see SUSPENDTASKAFTERNUMFAILURES.
- taskAuto NumberRetry Attempts 
- Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
- traceLevel String
- Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
- userTask StringManaged Initial Warehouse Size 
- The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
- userTask NumberMinimum Trigger Interval In Seconds 
- Minimum amount of time between Triggered Task executions in seconds.
- userTask NumberTimeout Ms 
- User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the snowflakeTerraform Provider.