Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake
  3. API Docs
  4. Database
Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi
pulumi/pulumi-snowflake

snowflake.Database

Explore with Pulumi AI

snowflake logo
Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi
pulumi/pulumi-snowflake

    Import

    $ pulumi import snowflake:index/database:Database example 'database_name'

    Create Database Resource

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

    Constructor syntax

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

@overload
def Database(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             catalog: Optional[str] = None,
             comment: Optional[str] = None,
             data_retention_time_in_days: Optional[int] = None,
             default_ddl_collation: Optional[str] = None,
             drop_public_schema_on_creation: Optional[bool] = 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,
             replication: Optional[DatabaseReplicationArgs] = 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 NewDatabase(ctx *Context, name string, args *DatabaseArgs, opts ...ResourceOption) (*Database, error)
    public Database(string name, DatabaseArgs? args = null, CustomResourceOptions? opts = null)
    public Database(String name, DatabaseArgs args)
public Database(String name, DatabaseArgs args, CustomResourceOptions options)

    type: snowflake:Database
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 DatabaseArgs
    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 DatabaseArgs
    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 DatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseArgs
    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 databaseResource = new Snowflake.Database("databaseResource", new()
{
    Catalog = "string",
    Comment = "string",
    DataRetentionTimeInDays = 0,
    DefaultDdlCollation = "string",
    DropPublicSchemaOnCreation = false,
    EnableConsoleOutput = false,
    ExternalVolume = "string",
    IsTransient = false,
    LogLevel = "string",
    MaxDataExtensionTimeInDays = 0,
    Name = "string",
    QuotedIdentifiersIgnoreCase = false,
    ReplaceInvalidCharacters = false,
    Replication = new Snowflake.Inputs.DatabaseReplicationArgs
    {
        EnableToAccounts = new[]
        {
            new Snowflake.Inputs.DatabaseReplicationEnableToAccountArgs
            {
                AccountIdentifier = "string",
                WithFailover = false,
            },
        },
        IgnoreEditionCheck = false,
    },
    StorageSerializationPolicy = "string",
    SuspendTaskAfterNumFailures = 0,
    TaskAutoRetryAttempts = 0,
    TraceLevel = "string",
    UserTaskManagedInitialWarehouseSize = "string",
    UserTaskMinimumTriggerIntervalInSeconds = 0,
    UserTaskTimeoutMs = 0,
});

    example, err := snowflake.NewDatabase(ctx, "databaseResource", &snowflake.DatabaseArgs{
	Catalog:                     pulumi.String("string"),
	Comment:                     pulumi.String("string"),
	DataRetentionTimeInDays:     pulumi.Int(0),
	DefaultDdlCollation:         pulumi.String("string"),
	DropPublicSchemaOnCreation:  pulumi.Bool(false),
	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),
	Replication: &snowflake.DatabaseReplicationArgs{
		EnableToAccounts: snowflake.DatabaseReplicationEnableToAccountArray{
			&snowflake.DatabaseReplicationEnableToAccountArgs{
				AccountIdentifier: pulumi.String("string"),
				WithFailover:      pulumi.Bool(false),
			},
		},
		IgnoreEditionCheck: 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 databaseResource = new Database("databaseResource", DatabaseArgs.builder()
    .catalog("string")
    .comment("string")
    .dataRetentionTimeInDays(0)
    .defaultDdlCollation("string")
    .dropPublicSchemaOnCreation(false)
    .enableConsoleOutput(false)
    .externalVolume("string")
    .isTransient(false)
    .logLevel("string")
    .maxDataExtensionTimeInDays(0)
    .name("string")
    .quotedIdentifiersIgnoreCase(false)
    .replaceInvalidCharacters(false)
    .replication(DatabaseReplicationArgs.builder()
        .enableToAccounts(DatabaseReplicationEnableToAccountArgs.builder()
            .accountIdentifier("string")
            .withFailover(false)
            .build())
        .ignoreEditionCheck(false)
        .build())
    .storageSerializationPolicy("string")
    .suspendTaskAfterNumFailures(0)
    .taskAutoRetryAttempts(0)
    .traceLevel("string")
    .userTaskManagedInitialWarehouseSize("string")
    .userTaskMinimumTriggerIntervalInSeconds(0)
    .userTaskTimeoutMs(0)
    .build());

    database_resource = snowflake.Database("databaseResource",
    catalog="string",
    comment="string",
    data_retention_time_in_days=0,
    default_ddl_collation="string",
    drop_public_schema_on_creation=False,
    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,
    replication=snowflake.DatabaseReplicationArgs(
        enable_to_accounts=[snowflake.DatabaseReplicationEnableToAccountArgs(
            account_identifier="string",
            with_failover=False,
        )],
        ignore_edition_check=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 databaseResource = new snowflake.Database("databaseResource", {
    catalog: "string",
    comment: "string",
    dataRetentionTimeInDays: 0,
    defaultDdlCollation: "string",
    dropPublicSchemaOnCreation: false,
    enableConsoleOutput: false,
    externalVolume: "string",
    isTransient: false,
    logLevel: "string",
    maxDataExtensionTimeInDays: 0,
    name: "string",
    quotedIdentifiersIgnoreCase: false,
    replaceInvalidCharacters: false,
    replication: {
        enableToAccounts: [{
            accountIdentifier: "string",
            withFailover: false,
        }],
        ignoreEditionCheck: false,
    },
    storageSerializationPolicy: "string",
    suspendTaskAfterNumFailures: 0,
    taskAutoRetryAttempts: 0,
    traceLevel: "string",
    userTaskManagedInitialWarehouseSize: "string",
    userTaskMinimumTriggerIntervalInSeconds: 0,
    userTaskTimeoutMs: 0,
});

    type: snowflake:Database
properties:
    catalog: string
    comment: string
    dataRetentionTimeInDays: 0
    defaultDdlCollation: string
    dropPublicSchemaOnCreation: false
    enableConsoleOutput: false
    externalVolume: string
    isTransient: false
    logLevel: string
    maxDataExtensionTimeInDays: 0
    name: string
    quotedIdentifiersIgnoreCase: false
    replaceInvalidCharacters: false
    replication:
        enableToAccounts:
            - accountIdentifier: string
              withFailover: false
        ignoreEditionCheck: false
    storageSerializationPolicy: string
    suspendTaskAfterNumFailures: 0
    taskAutoRetryAttempts: 0
    traceLevel: string
    userTaskManagedInitialWarehouseSize: string
    userTaskMinimumTriggerIntervalInSeconds: 0
    userTaskTimeoutMs: 0

    Database Resource Properties

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

    Inputs

    The Database resource accepts the following input properties:

    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.
    DataRetentionTimeInDays int
    Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
    DefaultDdlCollation string
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    DropPublicSchemaOnCreation bool
    Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
    EnableConsoleOutput bool
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    ExternalVolume string
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    IsTransient 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.
    MaxDataExtensionTimeInDays int
    Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
    Name string
    Specifies the identifier for the 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: |, ., (, ), "
    QuotedIdentifiersIgnoreCase bool
    If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
    ReplaceInvalidCharacters bool
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
    Replication DatabaseReplication
    Configures replication for a given database. When specified, this database will be promoted to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database.
    StorageSerializationPolicy string
    The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
    SuspendTaskAfterNumFailures int
    How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
    TaskAutoRetryAttempts int
    Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
    TraceLevel string
    Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
    UserTaskManagedInitialWarehouseSize string
    The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
    UserTaskMinimumTriggerIntervalInSeconds int
    Minimum amount of time between Triggered Task executions in seconds.
    UserTaskTimeoutMs int
    User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
    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.
    DataRetentionTimeInDays int
    Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
    DefaultDdlCollation string
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    DropPublicSchemaOnCreation bool
    Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
    EnableConsoleOutput bool
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    ExternalVolume string
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    IsTransient 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.
    MaxDataExtensionTimeInDays int
    Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
    Name string
    Specifies the identifier for the 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: |, ., (, ), "
    QuotedIdentifiersIgnoreCase bool
    If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
    ReplaceInvalidCharacters bool
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
    Replication DatabaseReplicationArgs
    Configures replication for a given database. When specified, this database will be promoted to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database.
    StorageSerializationPolicy string
    The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
    SuspendTaskAfterNumFailures int
    How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
    TaskAutoRetryAttempts int
    Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
    TraceLevel string
    Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
    UserTaskManagedInitialWarehouseSize string
    The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
    UserTaskMinimumTriggerIntervalInSeconds int
    Minimum amount of time between Triggered Task executions in seconds.
    UserTaskTimeoutMs int
    User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
    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.
    dataRetentionTimeInDays Integer
    Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
    defaultDdlCollation String
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    dropPublicSchemaOnCreation Boolean
    Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
    enableConsoleOutput Boolean
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    externalVolume String
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    isTransient 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.
    maxDataExtensionTimeInDays Integer
    Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
    name String
    Specifies the identifier for the 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: |, ., (, ), "
    quotedIdentifiersIgnoreCase Boolean
    If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
    replaceInvalidCharacters Boolean
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
    replication DatabaseReplication
    Configures replication for a given database. When specified, this database will be promoted to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database.
    storageSerializationPolicy String
    The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
    suspendTaskAfterNumFailures Integer
    How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
    taskAutoRetryAttempts Integer
    Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
    traceLevel String
    Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
    userTaskManagedInitialWarehouseSize String
    The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
    userTaskMinimumTriggerIntervalInSeconds Integer
    Minimum amount of time between Triggered Task executions in seconds.
    userTaskTimeoutMs Integer
    User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
    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.
    dataRetentionTimeInDays number
    Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
    defaultDdlCollation string
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    dropPublicSchemaOnCreation boolean
    Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
    enableConsoleOutput boolean
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    externalVolume string
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    isTransient 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.
    maxDataExtensionTimeInDays number
    Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
    name string
    Specifies the identifier for the 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: |, ., (, ), "
    quotedIdentifiersIgnoreCase boolean
    If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
    replaceInvalidCharacters boolean
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
    replication DatabaseReplication
    Configures replication for a given database. When specified, this database will be promoted to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database.
    storageSerializationPolicy string
    The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
    suspendTaskAfterNumFailures number
    How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
    taskAutoRetryAttempts number
    Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
    traceLevel string
    Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
    userTaskManagedInitialWarehouseSize string
    The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
    userTaskMinimumTriggerIntervalInSeconds number
    Minimum amount of time between Triggered Task executions in seconds.
    userTaskTimeoutMs number
    User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
    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_time_in_days int
    Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
    default_ddl_collation str
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    drop_public_schema_on_creation bool
    Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
    enable_console_output bool
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    external_volume str
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    is_transient 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_extension_time_in_days int
    Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
    name str
    Specifies the identifier for the 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_ignore_case bool
    If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
    replace_invalid_characters bool
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
    replication DatabaseReplicationArgs
    Configures replication for a given database. When specified, this database will be promoted to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database.
    storage_serialization_policy str
    The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
    suspend_task_after_num_failures int
    How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
    task_auto_retry_attempts int
    Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
    trace_level str
    Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
    user_task_managed_initial_warehouse_size str
    The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
    user_task_minimum_trigger_interval_in_seconds int
    Minimum amount of time between Triggered Task executions in seconds.
    user_task_timeout_ms int
    User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
    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.
    dataRetentionTimeInDays Number
    Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
    defaultDdlCollation String
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    dropPublicSchemaOnCreation Boolean
    Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
    enableConsoleOutput Boolean
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    externalVolume String
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    isTransient 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.
    maxDataExtensionTimeInDays Number
    Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
    name String
    Specifies the identifier for the 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: |, ., (, ), "
    quotedIdentifiersIgnoreCase Boolean
    If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
    replaceInvalidCharacters Boolean
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
    replication Property Map
    Configures replication for a given database. When specified, this database will be promoted to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database.
    storageSerializationPolicy String
    The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
    suspendTaskAfterNumFailures Number
    How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
    taskAutoRetryAttempts Number
    Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
    traceLevel String
    Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
    userTaskManagedInitialWarehouseSize String
    The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
    userTaskMinimumTriggerIntervalInSeconds Number
    Minimum amount of time between Triggered Task executions in seconds.
    userTaskTimeoutMs Number
    User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.

    Outputs

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

    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    id string
    The provider-assigned unique ID for this managed resource.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    id str
    The provider-assigned unique ID for this managed resource.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Database Resource

    Get an existing Database 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?: DatabaseState, opts?: CustomResourceOptions): Database
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog: Optional[str] = None,
        comment: Optional[str] = None,
        data_retention_time_in_days: Optional[int] = None,
        default_ddl_collation: Optional[str] = None,
        drop_public_schema_on_creation: Optional[bool] = 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,
        replication: Optional[DatabaseReplicationArgs] = 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) -> Database
    func GetDatabase(ctx *Context, name string, id IDInput, state *DatabaseState, opts ...ResourceOption) (*Database, error)
    public static Database Get(string name, Input<string> id, DatabaseState? state, CustomResourceOptions? opts = null)
    public static Database get(String name, Output<String> id, DatabaseState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Catalog string
    The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
    Comment string
    Specifies a comment for the database.
    DataRetentionTimeInDays int
    Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
    DefaultDdlCollation string
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    DropPublicSchemaOnCreation bool
    Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
    EnableConsoleOutput bool
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    ExternalVolume string
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    IsTransient 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.
    MaxDataExtensionTimeInDays int
    Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
    Name string
    Specifies the identifier for the 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: |, ., (, ), "
    QuotedIdentifiersIgnoreCase bool
    If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
    ReplaceInvalidCharacters bool
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
    Replication DatabaseReplication
    Configures replication for a given database. When specified, this database will be promoted to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database.
    StorageSerializationPolicy string
    The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
    SuspendTaskAfterNumFailures int
    How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
    TaskAutoRetryAttempts int
    Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
    TraceLevel string
    Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
    UserTaskManagedInitialWarehouseSize string
    The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
    UserTaskMinimumTriggerIntervalInSeconds int
    Minimum amount of time between Triggered Task executions in seconds.
    UserTaskTimeoutMs int
    User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
    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.
    DataRetentionTimeInDays int
    Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
    DefaultDdlCollation string
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    DropPublicSchemaOnCreation bool
    Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
    EnableConsoleOutput bool
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    ExternalVolume string
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    IsTransient 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.
    MaxDataExtensionTimeInDays int
    Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
    Name string
    Specifies the identifier for the 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: |, ., (, ), "
    QuotedIdentifiersIgnoreCase bool
    If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
    ReplaceInvalidCharacters bool
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
    Replication DatabaseReplicationArgs
    Configures replication for a given database. When specified, this database will be promoted to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database.
    StorageSerializationPolicy string
    The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
    SuspendTaskAfterNumFailures int
    How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
    TaskAutoRetryAttempts int
    Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
    TraceLevel string
    Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
    UserTaskManagedInitialWarehouseSize string
    The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
    UserTaskMinimumTriggerIntervalInSeconds int
    Minimum amount of time between Triggered Task executions in seconds.
    UserTaskTimeoutMs int
    User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
    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.
    dataRetentionTimeInDays Integer
    Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
    defaultDdlCollation String
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    dropPublicSchemaOnCreation Boolean
    Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
    enableConsoleOutput Boolean
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    externalVolume String
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    isTransient 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.
    maxDataExtensionTimeInDays Integer
    Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
    name String
    Specifies the identifier for the 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: |, ., (, ), "
    quotedIdentifiersIgnoreCase Boolean
    If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
    replaceInvalidCharacters Boolean
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
    replication DatabaseReplication
    Configures replication for a given database. When specified, this database will be promoted to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database.
    storageSerializationPolicy String
    The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
    suspendTaskAfterNumFailures Integer
    How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
    taskAutoRetryAttempts Integer
    Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
    traceLevel String
    Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
    userTaskManagedInitialWarehouseSize String
    The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
    userTaskMinimumTriggerIntervalInSeconds Integer
    Minimum amount of time between Triggered Task executions in seconds.
    userTaskTimeoutMs Integer
    User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
    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.
    dataRetentionTimeInDays number
    Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
    defaultDdlCollation string
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    dropPublicSchemaOnCreation boolean
    Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
    enableConsoleOutput boolean
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    externalVolume string
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    isTransient 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.
    maxDataExtensionTimeInDays number
    Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
    name string
    Specifies the identifier for the 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: |, ., (, ), "
    quotedIdentifiersIgnoreCase boolean
    If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
    replaceInvalidCharacters boolean
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
    replication DatabaseReplication
    Configures replication for a given database. When specified, this database will be promoted to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database.
    storageSerializationPolicy string
    The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
    suspendTaskAfterNumFailures number
    How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
    taskAutoRetryAttempts number
    Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
    traceLevel string
    Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
    userTaskManagedInitialWarehouseSize string
    The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
    userTaskMinimumTriggerIntervalInSeconds number
    Minimum amount of time between Triggered Task executions in seconds.
    userTaskTimeoutMs number
    User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
    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_time_in_days int
    Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
    default_ddl_collation str
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    drop_public_schema_on_creation bool
    Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
    enable_console_output bool
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    external_volume str
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    is_transient 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_extension_time_in_days int
    Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
    name str
    Specifies the identifier for the 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_ignore_case bool
    If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
    replace_invalid_characters bool
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
    replication DatabaseReplicationArgs
    Configures replication for a given database. When specified, this database will be promoted to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database.
    storage_serialization_policy str
    The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
    suspend_task_after_num_failures int
    How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
    task_auto_retry_attempts int
    Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
    trace_level str
    Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
    user_task_managed_initial_warehouse_size str
    The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
    user_task_minimum_trigger_interval_in_seconds int
    Minimum amount of time between Triggered Task executions in seconds.
    user_task_timeout_ms int
    User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.
    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.
    dataRetentionTimeInDays Number
    Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. For more details, see Understanding & Using Time Travel.
    defaultDdlCollation String
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    dropPublicSchemaOnCreation Boolean
    Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
    enableConsoleOutput Boolean
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    externalVolume String
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    isTransient 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.
    maxDataExtensionTimeInDays Number
    Object parameter that specifies the maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. For a detailed description of this parameter, see MAXDATAEXTENSIONTIMEIN_DAYS.
    name String
    Specifies the identifier for the 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: |, ., (, ), "
    quotedIdentifiersIgnoreCase Boolean
    If true, the case of quoted identifiers is ignored. For more information, see QUOTEDIDENTIFIERSIGNORE_CASE.
    replaceInvalidCharacters Boolean
    Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, see REPLACEINVALIDCHARACTERS.
    replication Property Map
    Configures replication for a given database. When specified, this database will be promoted to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database.
    storageSerializationPolicy String
    The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. For more information, see STORAGESERIALIZATIONPOLICY.
    suspendTaskAfterNumFailures Number
    How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, see SUSPENDTASKAFTERNUMFAILURES.
    taskAutoRetryAttempts Number
    Maximum automatic retries allowed for a user task. For more information, see TASKAUTORETRY_ATTEMPTS.
    traceLevel String
    Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON*EVENT OFF]. For information about levels, see TRACE*LEVEL.
    userTaskManagedInitialWarehouseSize String
    The initial size of warehouse to use for managed warehouses in the absence of history. For more information, see USERTASKMANAGEDINITIALWAREHOUSE_SIZE.
    userTaskMinimumTriggerIntervalInSeconds Number
    Minimum amount of time between Triggered Task executions in seconds.
    userTaskTimeoutMs Number
    User task execution timeout in milliseconds. For more information, see USERTASKTIMEOUT_MS.

    Supporting Types

    DatabaseReplication, DatabaseReplicationArgs

    EnableToAccounts List<DatabaseReplicationEnableToAccount>
    Entry to enable replication and optionally failover for a given account identifier.
    IgnoreEditionCheck bool
    Allows replicating data to accounts on lower editions in either of the following scenarios: 1. The primary database is in a Business Critical (or higher) account but one or more of the accounts approved for replication are on lower editions. Business Critical Edition is intended for Snowflake accounts with extremely sensitive data. 2. The primary database is in a Business Critical (or higher) account and a signed business associate agreement is in place to store PHI data in the account per HIPAA and HITRUST regulations, but no such agreement is in place for one or more of the accounts approved for replication, regardless if they are Business Critical (or higher) accounts. Both scenarios are prohibited by default in an effort to help prevent account administrators for Business Critical (or higher) accounts from inadvertently replicating sensitive data to accounts on lower editions.
    EnableToAccounts []DatabaseReplicationEnableToAccount
    Entry to enable replication and optionally failover for a given account identifier.
    IgnoreEditionCheck bool
    Allows replicating data to accounts on lower editions in either of the following scenarios: 1. The primary database is in a Business Critical (or higher) account but one or more of the accounts approved for replication are on lower editions. Business Critical Edition is intended for Snowflake accounts with extremely sensitive data. 2. The primary database is in a Business Critical (or higher) account and a signed business associate agreement is in place to store PHI data in the account per HIPAA and HITRUST regulations, but no such agreement is in place for one or more of the accounts approved for replication, regardless if they are Business Critical (or higher) accounts. Both scenarios are prohibited by default in an effort to help prevent account administrators for Business Critical (or higher) accounts from inadvertently replicating sensitive data to accounts on lower editions.
    enableToAccounts List<DatabaseReplicationEnableToAccount>
    Entry to enable replication and optionally failover for a given account identifier.
    ignoreEditionCheck Boolean
    Allows replicating data to accounts on lower editions in either of the following scenarios: 1. The primary database is in a Business Critical (or higher) account but one or more of the accounts approved for replication are on lower editions. Business Critical Edition is intended for Snowflake accounts with extremely sensitive data. 2. The primary database is in a Business Critical (or higher) account and a signed business associate agreement is in place to store PHI data in the account per HIPAA and HITRUST regulations, but no such agreement is in place for one or more of the accounts approved for replication, regardless if they are Business Critical (or higher) accounts. Both scenarios are prohibited by default in an effort to help prevent account administrators for Business Critical (or higher) accounts from inadvertently replicating sensitive data to accounts on lower editions.
    enableToAccounts DatabaseReplicationEnableToAccount[]
    Entry to enable replication and optionally failover for a given account identifier.
    ignoreEditionCheck boolean
    Allows replicating data to accounts on lower editions in either of the following scenarios: 1. The primary database is in a Business Critical (or higher) account but one or more of the accounts approved for replication are on lower editions. Business Critical Edition is intended for Snowflake accounts with extremely sensitive data. 2. The primary database is in a Business Critical (or higher) account and a signed business associate agreement is in place to store PHI data in the account per HIPAA and HITRUST regulations, but no such agreement is in place for one or more of the accounts approved for replication, regardless if they are Business Critical (or higher) accounts. Both scenarios are prohibited by default in an effort to help prevent account administrators for Business Critical (or higher) accounts from inadvertently replicating sensitive data to accounts on lower editions.
    enable_to_accounts Sequence[DatabaseReplicationEnableToAccount]
    Entry to enable replication and optionally failover for a given account identifier.
    ignore_edition_check bool
    Allows replicating data to accounts on lower editions in either of the following scenarios: 1. The primary database is in a Business Critical (or higher) account but one or more of the accounts approved for replication are on lower editions. Business Critical Edition is intended for Snowflake accounts with extremely sensitive data. 2. The primary database is in a Business Critical (or higher) account and a signed business associate agreement is in place to store PHI data in the account per HIPAA and HITRUST regulations, but no such agreement is in place for one or more of the accounts approved for replication, regardless if they are Business Critical (or higher) accounts. Both scenarios are prohibited by default in an effort to help prevent account administrators for Business Critical (or higher) accounts from inadvertently replicating sensitive data to accounts on lower editions.
    enableToAccounts List<Property Map>
    Entry to enable replication and optionally failover for a given account identifier.
    ignoreEditionCheck Boolean
    Allows replicating data to accounts on lower editions in either of the following scenarios: 1. The primary database is in a Business Critical (or higher) account but one or more of the accounts approved for replication are on lower editions. Business Critical Edition is intended for Snowflake accounts with extremely sensitive data. 2. The primary database is in a Business Critical (or higher) account and a signed business associate agreement is in place to store PHI data in the account per HIPAA and HITRUST regulations, but no such agreement is in place for one or more of the accounts approved for replication, regardless if they are Business Critical (or higher) accounts. Both scenarios are prohibited by default in an effort to help prevent account administrators for Business Critical (or higher) accounts from inadvertently replicating sensitive data to accounts on lower editions.

    DatabaseReplicationEnableToAccount, DatabaseReplicationEnableToAccountArgs

    AccountIdentifier string
    Specifies account identifier for which replication should be enabled. The account identifiers should be in the form of "<organization_name>"."<account_name>".
    WithFailover bool
    Specifies if failover should be enabled for the specified account identifier
    AccountIdentifier string
    Specifies account identifier for which replication should be enabled. The account identifiers should be in the form of "<organization_name>"."<account_name>".
    WithFailover bool
    Specifies if failover should be enabled for the specified account identifier
    accountIdentifier String
    Specifies account identifier for which replication should be enabled. The account identifiers should be in the form of "<organization_name>"."<account_name>".
    withFailover Boolean
    Specifies if failover should be enabled for the specified account identifier
    accountIdentifier string
    Specifies account identifier for which replication should be enabled. The account identifiers should be in the form of "<organization_name>"."<account_name>".
    withFailover boolean
    Specifies if failover should be enabled for the specified account identifier
    account_identifier str
    Specifies account identifier for which replication should be enabled. The account identifiers should be in the form of "<organization_name>"."<account_name>".
    with_failover bool
    Specifies if failover should be enabled for the specified account identifier
    accountIdentifier String
    Specifies account identifier for which replication should be enabled. The account identifiers should be in the form of "<organization_name>"."<account_name>".
    withFailover Boolean
    Specifies if failover should be enabled for the specified account identifier

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi
    pulumi/pulumi-snowflake