Skip to content

Latest commit

 

History

History
1735 lines (1091 loc) · 78.4 KB

secondaryDatabase.go.md

File metadata and controls

1735 lines (1091 loc) · 78.4 KB

secondaryDatabase Submodule

Constructs

SecondaryDatabase

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database snowflake_secondary_database}.

Initializers 

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/secondarydatabase"

secondarydatabase.NewSecondaryDatabase(scope Construct, id *string, config SecondaryDatabaseConfig) SecondaryDatabase
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config SecondaryDatabaseConfig No description.
scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

idRequired
  • Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
ResetCatalog No description.
ResetComment No description.
ResetDataRetentionTimeInDays No description.
ResetDefaultDdlCollation No description.
ResetEnableConsoleOutput No description.
ResetExternalVolume No description.
ResetId No description.
ResetIsTransient No description.
ResetLogLevel No description.
ResetMaxDataExtensionTimeInDays No description.
ResetQuotedIdentifiersIgnoreCase No description.
ResetReplaceInvalidCharacters No description.
ResetStorageSerializationPolicy No description.
ResetSuspendTaskAfterNumFailures No description.
ResetTaskAutoRetryAttempts No description.
ResetTraceLevel No description.
ResetUserTaskManagedInitialWarehouseSize No description.
ResetUserTaskMinimumTriggerIntervalInSeconds No description.
ResetUserTaskTimeoutMs No description.
ToString 
func ToString() *string

Returns a string representation of this construct.

AddOverride 
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string
valueRequired
  • Type: interface{}
OverrideLogicalId 
func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform 
func ToHclTerraform() interface{}
ToMetadata 
func ToMetadata() interface{}
ToTerraform 
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget 
func AddMoveTarget(moveTarget *string)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: *string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
HasResourceMove 
func HasResourceMove() interface{}
ImportFrom 
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string
providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
InterpolationForAttribute 
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
MoveFromId 
func MoveFromId(id *string)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: *string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

MoveTo 
func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: *string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: interface{}

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

MoveToId 
func MoveToId(id *string)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: *string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

ResetCatalog 
func ResetCatalog()
ResetComment 
func ResetComment()
ResetDataRetentionTimeInDays 
func ResetDataRetentionTimeInDays()
ResetDefaultDdlCollation 
func ResetDefaultDdlCollation()
ResetEnableConsoleOutput 
func ResetEnableConsoleOutput()
ResetExternalVolume 
func ResetExternalVolume()
ResetId 
func ResetId()
ResetIsTransient 
func ResetIsTransient()
ResetLogLevel 
func ResetLogLevel()
ResetMaxDataExtensionTimeInDays 
func ResetMaxDataExtensionTimeInDays()
ResetQuotedIdentifiersIgnoreCase 
func ResetQuotedIdentifiersIgnoreCase()
ResetReplaceInvalidCharacters 
func ResetReplaceInvalidCharacters()
ResetStorageSerializationPolicy 
func ResetStorageSerializationPolicy()
ResetSuspendTaskAfterNumFailures 
func ResetSuspendTaskAfterNumFailures()
ResetTaskAutoRetryAttempts 
func ResetTaskAutoRetryAttempts()
ResetTraceLevel 
func ResetTraceLevel()
ResetUserTaskManagedInitialWarehouseSize 
func ResetUserTaskManagedInitialWarehouseSize()
ResetUserTaskMinimumTriggerIntervalInSeconds 
func ResetUserTaskMinimumTriggerIntervalInSeconds()
ResetUserTaskTimeoutMs 
func ResetUserTaskTimeoutMs()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a SecondaryDatabase resource upon running "cdktf plan ".
IsConstruct 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/secondarydatabase"

secondarydatabase.SecondaryDatabase_IsConstruct(x interface{}) *bool

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: interface{}

Any object.

IsTerraformElement 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/secondarydatabase"

secondarydatabase.SecondaryDatabase_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformResource 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/secondarydatabase"

secondarydatabase.SecondaryDatabase_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/secondarydatabase"

secondarydatabase.SecondaryDatabase_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a SecondaryDatabase resource upon running "cdktf plan ".

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: *string

The construct id used in the generated config for the SecondaryDatabase to import.

importFromIdRequired
  • Type: *string

The id of the existing SecondaryDatabase that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the SecondaryDatabase to import is found.

Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
FullyQualifiedName *string No description.
AsReplicaOfInput *string No description.
CatalogInput *string No description.
CommentInput *string No description.
DataRetentionTimeInDaysInput *f64 No description.
DefaultDdlCollationInput *string No description.
EnableConsoleOutputInput interface{} No description.
ExternalVolumeInput *string No description.
IdInput *string No description.
IsTransientInput interface{} No description.
LogLevelInput *string No description.
MaxDataExtensionTimeInDaysInput *f64 No description.
NameInput *string No description.
QuotedIdentifiersIgnoreCaseInput interface{} No description.
ReplaceInvalidCharactersInput interface{} No description.
StorageSerializationPolicyInput *string No description.
SuspendTaskAfterNumFailuresInput *f64 No description.
TaskAutoRetryAttemptsInput *f64 No description.
TraceLevelInput *string No description.
UserTaskManagedInitialWarehouseSizeInput *string No description.
UserTaskMinimumTriggerIntervalInSecondsInput *f64 No description.
UserTaskTimeoutMsInput *f64 No description.
AsReplicaOf *string No description.
Catalog *string No description.
Comment *string No description.
DataRetentionTimeInDays *f64 No description.
DefaultDdlCollation *string No description.
EnableConsoleOutput interface{} No description.
ExternalVolume *string No description.
Id *string No description.
IsTransient interface{} No description.
LogLevel *string No description.
MaxDataExtensionTimeInDays *f64 No description.
Name *string No description.
QuotedIdentifiersIgnoreCase interface{} No description.
ReplaceInvalidCharacters interface{} No description.
StorageSerializationPolicy *string No description.
SuspendTaskAfterNumFailures *f64 No description.
TaskAutoRetryAttempts *f64 No description.
TraceLevel *string No description.
UserTaskManagedInitialWarehouseSize *string No description.
UserTaskMinimumTriggerIntervalInSeconds *f64 No description.
UserTaskTimeoutMs *f64 No description.
NodeRequired 
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

CdktfStackRequired 
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
FqnRequired 
func Fqn() *string
  • Type: *string
FriendlyUniqueIdRequired 
func FriendlyUniqueId() *string
  • Type: *string
TerraformMetaArgumentsRequired 
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}
TerraformResourceTypeRequired 
func TerraformResourceType() *string
  • Type: *string
TerraformGeneratorMetadataOptional 
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
func Connection() interface{}
  • Type: interface{}
CountOptional 
func Count() interface{}
  • Type: interface{}
DependsOnOptional 
func DependsOn() *[]*string
  • Type: *[]*string
ForEachOptional 
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
func Provisioners() *[]interface{}
  • Type: *[]interface{}
FullyQualifiedNameRequired 
func FullyQualifiedName() *string
  • Type: *string
AsReplicaOfInputOptional 
func AsReplicaOfInput() *string
  • Type: *string
CatalogInputOptional 
func CatalogInput() *string
  • Type: *string
CommentInputOptional 
func CommentInput() *string
  • Type: *string
DataRetentionTimeInDaysInputOptional 
func DataRetentionTimeInDaysInput() *f64
  • Type: *f64
DefaultDdlCollationInputOptional 
func DefaultDdlCollationInput() *string
  • Type: *string
EnableConsoleOutputInputOptional 
func EnableConsoleOutputInput() interface{}
  • Type: interface{}
ExternalVolumeInputOptional 
func ExternalVolumeInput() *string
  • Type: *string
IdInputOptional 
func IdInput() *string
  • Type: *string
IsTransientInputOptional 
func IsTransientInput() interface{}
  • Type: interface{}
LogLevelInputOptional 
func LogLevelInput() *string
  • Type: *string
MaxDataExtensionTimeInDaysInputOptional 
func MaxDataExtensionTimeInDaysInput() *f64
  • Type: *f64
NameInputOptional 
func NameInput() *string
  • Type: *string
QuotedIdentifiersIgnoreCaseInputOptional 
func QuotedIdentifiersIgnoreCaseInput() interface{}
  • Type: interface{}
ReplaceInvalidCharactersInputOptional 
func ReplaceInvalidCharactersInput() interface{}
  • Type: interface{}
StorageSerializationPolicyInputOptional 
func StorageSerializationPolicyInput() *string
  • Type: *string
SuspendTaskAfterNumFailuresInputOptional 
func SuspendTaskAfterNumFailuresInput() *f64
  • Type: *f64
TaskAutoRetryAttemptsInputOptional 
func TaskAutoRetryAttemptsInput() *f64
  • Type: *f64
TraceLevelInputOptional 
func TraceLevelInput() *string
  • Type: *string
UserTaskManagedInitialWarehouseSizeInputOptional 
func UserTaskManagedInitialWarehouseSizeInput() *string
  • Type: *string
UserTaskMinimumTriggerIntervalInSecondsInputOptional 
func UserTaskMinimumTriggerIntervalInSecondsInput() *f64
  • Type: *f64
UserTaskTimeoutMsInputOptional 
func UserTaskTimeoutMsInput() *f64
  • Type: *f64
AsReplicaOfRequired 
func AsReplicaOf() *string
  • Type: *string
CatalogRequired 
func Catalog() *string
  • Type: *string
CommentRequired 
func Comment() *string
  • Type: *string
DataRetentionTimeInDaysRequired 
func DataRetentionTimeInDays() *f64
  • Type: *f64
DefaultDdlCollationRequired 
func DefaultDdlCollation() *string
  • Type: *string
EnableConsoleOutputRequired 
func EnableConsoleOutput() interface{}
  • Type: interface{}
ExternalVolumeRequired 
func ExternalVolume() *string
  • Type: *string
IdRequired 
func Id() *string
  • Type: *string
IsTransientRequired 
func IsTransient() interface{}
  • Type: interface{}
LogLevelRequired 
func LogLevel() *string
  • Type: *string
MaxDataExtensionTimeInDaysRequired 
func MaxDataExtensionTimeInDays() *f64
  • Type: *f64
NameRequired 
func Name() *string
  • Type: *string
QuotedIdentifiersIgnoreCaseRequired 
func QuotedIdentifiersIgnoreCase() interface{}
  • Type: interface{}
ReplaceInvalidCharactersRequired 
func ReplaceInvalidCharacters() interface{}
  • Type: interface{}
StorageSerializationPolicyRequired 
func StorageSerializationPolicy() *string
  • Type: *string
SuspendTaskAfterNumFailuresRequired 
func SuspendTaskAfterNumFailures() *f64
  • Type: *f64
TaskAutoRetryAttemptsRequired 
func TaskAutoRetryAttempts() *f64
  • Type: *f64
TraceLevelRequired 
func TraceLevel() *string
  • Type: *string
UserTaskManagedInitialWarehouseSizeRequired 
func UserTaskManagedInitialWarehouseSize() *string
  • Type: *string
UserTaskMinimumTriggerIntervalInSecondsRequired 
func UserTaskMinimumTriggerIntervalInSeconds() *f64
  • Type: *f64
UserTaskTimeoutMsRequired 
func UserTaskTimeoutMs() *f64
  • Type: *f64

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

SecondaryDatabaseConfig

Initializer 

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/secondarydatabase"

&secondarydatabase.SecondaryDatabaseConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	AsReplicaOf: *string,
	Name: *string,
	Catalog: *string,
	Comment: *string,
	DataRetentionTimeInDays: *f64,
	DefaultDdlCollation: *string,
	EnableConsoleOutput: interface{},
	ExternalVolume: *string,
	Id: *string,
	IsTransient: interface{},
	LogLevel: *string,
	MaxDataExtensionTimeInDays: *f64,
	QuotedIdentifiersIgnoreCase: interface{},
	ReplaceInvalidCharacters: interface{},
	StorageSerializationPolicy: *string,
	SuspendTaskAfterNumFailures: *f64,
	TaskAutoRetryAttempts: *f64,
	TraceLevel: *string,
	UserTaskManagedInitialWarehouseSize: *string,
	UserTaskMinimumTriggerIntervalInSeconds: *f64,
	UserTaskTimeoutMs: *f64,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
AsReplicaOf *string A fully qualified path to a database to create a replica from.
Name *string Specifies the identifier for the database;
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 *f64 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.
DefaultDdlCollation *string Specifies a default collation specification for all schemas and tables added to the database.
EnableConsoleOutput interface{} 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.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#id SecondaryDatabase#id}.
IsTransient interface{} Specifies the database as transient.
LogLevel *string Specifies the severity level of messages that should be ingested and made available in the active event table.
MaxDataExtensionTimeInDays *f64 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.
QuotedIdentifiersIgnoreCase interface{} If true, the case of quoted identifiers is ignored. For more information, see QUOTED_IDENTIFIERS_IGNORE_CASE.
ReplaceInvalidCharacters interface{} Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table.
StorageSerializationPolicy *string The storage serialization policy for Iceberg tables that use Snowflake as the catalog.
SuspendTaskAfterNumFailures *f64 How many times a task must fail in a row before it is automatically suspended.
TaskAutoRetryAttempts *f64 Maximum automatic retries allowed for a user task. For more information, see TASK_AUTO_RETRY_ATTEMPTS.
TraceLevel *string Controls how trace events are ingested into the event table.
UserTaskManagedInitialWarehouseSize *string The initial size of warehouse to use for managed warehouses in the absence of history.
UserTaskMinimumTriggerIntervalInSeconds *f64 Minimum amount of time between Triggered Task executions in seconds.
UserTaskTimeoutMs *f64 User task execution timeout in milliseconds. For more information, see USER_TASK_TIMEOUT_MS.
ConnectionOptional 
Connection interface{}
  • Type: interface{}
CountOptional 
Count interface{}
  • Type: interface{}
DependsOnOptional 
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEachOptional 
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
Provisioners *[]interface{}
  • Type: *[]interface{}
AsReplicaOfRequired 
AsReplicaOf *string
  • Type: *string

A fully qualified path to a database to create a replica from.

A fully qualified path follows the format of "<organization_name>"."<account_name>"."<database_name>". For more information about this resource, see docs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#as_replica_of SecondaryDatabase#as_replica_of}

NameRequired 
Name *string
  • Type: *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. '..') 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: |, ., ".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#name SecondaryDatabase#name}

CatalogOptional 
Catalog *string
  • Type: *string

The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#catalog SecondaryDatabase#catalog}

CommentOptional 
Comment *string
  • Type: *string

Specifies a comment for the database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#comment SecondaryDatabase#comment}

DataRetentionTimeInDaysOptional 
DataRetentionTimeInDays *f64
  • Type: *f64

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#data_retention_time_in_days SecondaryDatabase#data_retention_time_in_days}

DefaultDdlCollationOptional 
DefaultDdlCollation *string
  • Type: *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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#default_ddl_collation SecondaryDatabase#default_ddl_collation}

EnableConsoleOutputOptional 
EnableConsoleOutput interface{}
  • Type: interface{}

If true, enables stdout/stderr fast path logging for anonymous stored procedures.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#enable_console_output SecondaryDatabase#enable_console_output}

ExternalVolumeOptional 
ExternalVolume *string
  • Type: *string

The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#external_volume SecondaryDatabase#external_volume}

IdOptional 
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#id SecondaryDatabase#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

IsTransientOptional 
IsTransient interface{}
  • Type: interface{}

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#is_transient SecondaryDatabase#is_transient}

LogLevelOptional 
LogLevel *string
  • Type: *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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#log_level SecondaryDatabase#log_level}

MaxDataExtensionTimeInDaysOptional 
MaxDataExtensionTimeInDays *f64
  • Type: *f64

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 MAX_DATA_EXTENSION_TIME_IN_DAYS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#max_data_extension_time_in_days SecondaryDatabase#max_data_extension_time_in_days}

QuotedIdentifiersIgnoreCaseOptional 
QuotedIdentifiersIgnoreCase interface{}
  • Type: interface{}

If true, the case of quoted identifiers is ignored. For more information, see QUOTED_IDENTIFIERS_IGNORE_CASE.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#quoted_identifiers_ignore_case SecondaryDatabase#quoted_identifiers_ignore_case}

ReplaceInvalidCharactersOptional 
ReplaceInvalidCharacters interface{}
  • Type: interface{}

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 REPLACE_INVALID_CHARACTERS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#replace_invalid_characters SecondaryDatabase#replace_invalid_characters}

StorageSerializationPolicyOptional 
StorageSerializationPolicy *string
  • Type: *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 STORAGE_SERIALIZATION_POLICY.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#storage_serialization_policy SecondaryDatabase#storage_serialization_policy}

SuspendTaskAfterNumFailuresOptional 
SuspendTaskAfterNumFailures *f64
  • Type: *f64

How many times a task must fail in a row before it is automatically suspended.

0 disables auto-suspending. For more information, see SUSPEND_TASK_AFTER_NUM_FAILURES.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#suspend_task_after_num_failures SecondaryDatabase#suspend_task_after_num_failures}

TaskAutoRetryAttemptsOptional 
TaskAutoRetryAttempts *f64
  • Type: *f64

Maximum automatic retries allowed for a user task. For more information, see TASK_AUTO_RETRY_ATTEMPTS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#task_auto_retry_attempts SecondaryDatabase#task_auto_retry_attempts}

TraceLevelOptional 
TraceLevel *string
  • Type: *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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#trace_level SecondaryDatabase#trace_level}

UserTaskManagedInitialWarehouseSizeOptional 
UserTaskManagedInitialWarehouseSize *string
  • Type: *string

The initial size of warehouse to use for managed warehouses in the absence of history.

For more information, see USER_TASK_MANAGED_INITIAL_WAREHOUSE_SIZE.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#user_task_managed_initial_warehouse_size SecondaryDatabase#user_task_managed_initial_warehouse_size}

UserTaskMinimumTriggerIntervalInSecondsOptional 
UserTaskMinimumTriggerIntervalInSeconds *f64
  • Type: *f64

Minimum amount of time between Triggered Task executions in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#user_task_minimum_trigger_interval_in_seconds SecondaryDatabase#user_task_minimum_trigger_interval_in_seconds}

UserTaskTimeoutMsOptional 
UserTaskTimeoutMs *f64
  • Type: *f64

User task execution timeout in milliseconds. For more information, see USER_TASK_TIMEOUT_MS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/secondary_database#user_task_timeout_ms SecondaryDatabase#user_task_timeout_ms}