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

snowflake.SharedDatabase

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/sharedDatabase:SharedDatabase example 'shared_database_name'

    Create SharedDatabase Resource

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

    Constructor syntax

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

@overload
def SharedDatabase(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   from_share: Optional[str] = None,
                   quoted_identifiers_ignore_case: Optional[bool] = None,
                   name: Optional[str] = None,
                   enable_console_output: Optional[bool] = None,
                   external_volume: Optional[str] = None,
                   replace_invalid_characters: Optional[bool] = None,
                   log_level: Optional[str] = None,
                   default_ddl_collation: Optional[str] = None,
                   catalog: Optional[str] = None,
                   comment: Optional[str] = None,
                   storage_serialization_policy: Optional[str] = None,
                   suspend_task_after_num_failures: Optional[int] = None,
                   task_auto_retry_attempts: Optional[int] = None,
                   trace_level: Optional[str] = None,
                   user_task_managed_initial_warehouse_size: Optional[str] = None,
                   user_task_minimum_trigger_interval_in_seconds: Optional[int] = None,
                   user_task_timeout_ms: Optional[int] = None)
    func NewSharedDatabase(ctx *Context, name string, args SharedDatabaseArgs, opts ...ResourceOption) (*SharedDatabase, error)
    public SharedDatabase(string name, SharedDatabaseArgs args, CustomResourceOptions? opts = null)
    public SharedDatabase(String name, SharedDatabaseArgs args)
public SharedDatabase(String name, SharedDatabaseArgs args, CustomResourceOptions options)

    type: snowflake:SharedDatabase
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 SharedDatabaseArgs
    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 SharedDatabaseArgs
    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 SharedDatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SharedDatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SharedDatabaseArgs
    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 sharedDatabaseResource = new Snowflake.SharedDatabase("sharedDatabaseResource", new()
{
    FromShare = "string",
    QuotedIdentifiersIgnoreCase = false,
    Name = "string",
    EnableConsoleOutput = false,
    ExternalVolume = "string",
    ReplaceInvalidCharacters = false,
    LogLevel = "string",
    DefaultDdlCollation = "string",
    Catalog = "string",
    Comment = "string",
    StorageSerializationPolicy = "string",
    SuspendTaskAfterNumFailures = 0,
    TaskAutoRetryAttempts = 0,
    TraceLevel = "string",
    UserTaskManagedInitialWarehouseSize = "string",
    UserTaskMinimumTriggerIntervalInSeconds = 0,
    UserTaskTimeoutMs = 0,
});

    example, err := snowflake.NewSharedDatabase(ctx, "sharedDatabaseResource", &snowflake.SharedDatabaseArgs{
	FromShare:                               pulumi.String("string"),
	QuotedIdentifiersIgnoreCase:             pulumi.Bool(false),
	Name:                                    pulumi.String("string"),
	EnableConsoleOutput:                     pulumi.Bool(false),
	ExternalVolume:                          pulumi.String("string"),
	ReplaceInvalidCharacters:                pulumi.Bool(false),
	LogLevel:                                pulumi.String("string"),
	DefaultDdlCollation:                     pulumi.String("string"),
	Catalog:                                 pulumi.String("string"),
	Comment:                                 pulumi.String("string"),
	StorageSerializationPolicy:              pulumi.String("string"),
	SuspendTaskAfterNumFailures:             pulumi.Int(0),
	TaskAutoRetryAttempts:                   pulumi.Int(0),
	TraceLevel:                              pulumi.String("string"),
	UserTaskManagedInitialWarehouseSize:     pulumi.String("string"),
	UserTaskMinimumTriggerIntervalInSeconds: pulumi.Int(0),
	UserTaskTimeoutMs:                       pulumi.Int(0),
})

    var sharedDatabaseResource = new SharedDatabase("sharedDatabaseResource", SharedDatabaseArgs.builder()
    .fromShare("string")
    .quotedIdentifiersIgnoreCase(false)
    .name("string")
    .enableConsoleOutput(false)
    .externalVolume("string")
    .replaceInvalidCharacters(false)
    .logLevel("string")
    .defaultDdlCollation("string")
    .catalog("string")
    .comment("string")
    .storageSerializationPolicy("string")
    .suspendTaskAfterNumFailures(0)
    .taskAutoRetryAttempts(0)
    .traceLevel("string")
    .userTaskManagedInitialWarehouseSize("string")
    .userTaskMinimumTriggerIntervalInSeconds(0)
    .userTaskTimeoutMs(0)
    .build());

    shared_database_resource = snowflake.SharedDatabase("sharedDatabaseResource",
    from_share="string",
    quoted_identifiers_ignore_case=False,
    name="string",
    enable_console_output=False,
    external_volume="string",
    replace_invalid_characters=False,
    log_level="string",
    default_ddl_collation="string",
    catalog="string",
    comment="string",
    storage_serialization_policy="string",
    suspend_task_after_num_failures=0,
    task_auto_retry_attempts=0,
    trace_level="string",
    user_task_managed_initial_warehouse_size="string",
    user_task_minimum_trigger_interval_in_seconds=0,
    user_task_timeout_ms=0)

    const sharedDatabaseResource = new snowflake.SharedDatabase("sharedDatabaseResource", {
    fromShare: "string",
    quotedIdentifiersIgnoreCase: false,
    name: "string",
    enableConsoleOutput: false,
    externalVolume: "string",
    replaceInvalidCharacters: false,
    logLevel: "string",
    defaultDdlCollation: "string",
    catalog: "string",
    comment: "string",
    storageSerializationPolicy: "string",
    suspendTaskAfterNumFailures: 0,
    taskAutoRetryAttempts: 0,
    traceLevel: "string",
    userTaskManagedInitialWarehouseSize: "string",
    userTaskMinimumTriggerIntervalInSeconds: 0,
    userTaskTimeoutMs: 0,
});

    type: snowflake:SharedDatabase
properties:
    catalog: string
    comment: string
    defaultDdlCollation: string
    enableConsoleOutput: false
    externalVolume: string
    fromShare: string
    logLevel: string
    name: string
    quotedIdentifiersIgnoreCase: false
    replaceInvalidCharacters: false
    storageSerializationPolicy: string
    suspendTaskAfterNumFailures: 0
    taskAutoRetryAttempts: 0
    traceLevel: string
    userTaskManagedInitialWarehouseSize: string
    userTaskMinimumTriggerIntervalInSeconds: 0
    userTaskTimeoutMs: 0

    SharedDatabase 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 SharedDatabase resource accepts the following input properties:

    FromShare string
    A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<share_name>".
    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.
    DefaultDdlCollation string
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    EnableConsoleOutput bool
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    ExternalVolume string
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    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.
    Name string
    Specifies the identifier for the database; must be unique for your account. 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.
    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.
    FromShare string
    A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<share_name>".
    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.
    DefaultDdlCollation string
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    EnableConsoleOutput bool
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    ExternalVolume string
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    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.
    Name string
    Specifies the identifier for the database; must be unique for your account. 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.
    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.
    fromShare String
    A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<share_name>".
    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.
    defaultDdlCollation String
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    enableConsoleOutput Boolean
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    externalVolume String
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    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.
    name String
    Specifies the identifier for the database; must be unique for your account. 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.
    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.
    fromShare string
    A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<share_name>".
    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.
    defaultDdlCollation string
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    enableConsoleOutput boolean
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    externalVolume string
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    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.
    name string
    Specifies the identifier for the database; must be unique for your account. 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.
    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.
    from_share str
    A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<share_name>".
    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.
    default_ddl_collation str
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    enable_console_output bool
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    external_volume str
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    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.
    name str
    Specifies the identifier for the database; must be unique for your account. 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.
    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.
    fromShare String
    A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<share_name>".
    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.
    defaultDdlCollation String
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    enableConsoleOutput Boolean
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    externalVolume String
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    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.
    name String
    Specifies the identifier for the database; must be unique for your account. 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.
    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 SharedDatabase 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 SharedDatabase Resource

    Get an existing SharedDatabase 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?: SharedDatabaseState, opts?: CustomResourceOptions): SharedDatabase
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog: Optional[str] = None,
        comment: Optional[str] = None,
        default_ddl_collation: Optional[str] = None,
        enable_console_output: Optional[bool] = None,
        external_volume: Optional[str] = None,
        from_share: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        log_level: Optional[str] = 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) -> SharedDatabase
    func GetSharedDatabase(ctx *Context, name string, id IDInput, state *SharedDatabaseState, opts ...ResourceOption) (*SharedDatabase, error)
    public static SharedDatabase Get(string name, Input<string> id, SharedDatabaseState? state, CustomResourceOptions? opts = null)
    public static SharedDatabase get(String name, Output<String> id, SharedDatabaseState 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.
    DefaultDdlCollation string
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    EnableConsoleOutput bool
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    ExternalVolume string
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    FromShare string
    A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<share_name>".
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    Name string
    Specifies the identifier for the database; must be unique for your account. 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.
    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.
    DefaultDdlCollation string
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    EnableConsoleOutput bool
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    ExternalVolume string
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    FromShare string
    A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<share_name>".
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    Name string
    Specifies the identifier for the database; must be unique for your account. 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.
    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.
    defaultDdlCollation String
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    enableConsoleOutput Boolean
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    externalVolume String
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    fromShare String
    A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<share_name>".
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    name String
    Specifies the identifier for the database; must be unique for your account. 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.
    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.
    defaultDdlCollation string
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    enableConsoleOutput boolean
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    externalVolume string
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    fromShare string
    A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<share_name>".
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    name string
    Specifies the identifier for the database; must be unique for your account. 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.
    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.
    default_ddl_collation str
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    enable_console_output bool
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    external_volume str
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    from_share str
    A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<share_name>".
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    name str
    Specifies the identifier for the database; must be unique for your account. 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.
    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.
    defaultDdlCollation String
    Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification.
    enableConsoleOutput Boolean
    If true, enables stdout/stderr fast path logging for anonymous stored procedures.
    externalVolume String
    The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
    fromShare String
    A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<share_name>".
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    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.
    name String
    Specifies the identifier for the database; must be unique for your account. 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.
    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.

    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