Skip to content

Latest commit

 

History

History
2660 lines (1643 loc) · 120 KB

database.typescript.md

File metadata and controls

2660 lines (1643 loc) · 120 KB
Raw

database Submodule

Constructs

Database

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/database snowflake_database}.

Initializers 

import { database } from '@cdktf/provider-snowflake'

new database.Database(scope: Construct, id: string, config: DatabaseConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DatabaseConfig No description.
scopeRequired
  • Type: constructs.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".
putReplication No description.
resetCatalog No description.
resetComment No description.
resetDataRetentionTimeInDays No description.
resetDefaultDdlCollation No description.
resetDropPublicSchemaOnCreation 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.
resetReplication No description.
resetStorageSerializationPolicy No description.
resetSuspendTaskAfterNumFailures No description.
resetTaskAutoRetryAttempts No description.
resetTraceLevel No description.
resetUserTaskManagedInitialWarehouseSize No description.
resetUserTaskMinimumTriggerIntervalInSeconds No description.
resetUserTaskTimeoutMs No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

toHclTerraform 
public toHclTerraform(): any
toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget 
public addMoveTarget(moveTarget: string): void

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 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
moveFromId 
public moveFromId(id: string): void

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 
public moveTo(moveTarget: string, index?: string | number): void

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: string | number

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

moveToId 
public moveToId(id: string): void

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

putReplication 
public putReplication(value: DatabaseReplication): void
valueRequired
resetCatalog 
public resetCatalog(): void
resetComment 
public resetComment(): void
resetDataRetentionTimeInDays 
public resetDataRetentionTimeInDays(): void
resetDefaultDdlCollation 
public resetDefaultDdlCollation(): void
resetDropPublicSchemaOnCreation 
public resetDropPublicSchemaOnCreation(): void
resetEnableConsoleOutput 
public resetEnableConsoleOutput(): void
resetExternalVolume 
public resetExternalVolume(): void
resetId 
public resetId(): void
resetIsTransient 
public resetIsTransient(): void
resetLogLevel 
public resetLogLevel(): void
resetMaxDataExtensionTimeInDays 
public resetMaxDataExtensionTimeInDays(): void
resetQuotedIdentifiersIgnoreCase 
public resetQuotedIdentifiersIgnoreCase(): void
resetReplaceInvalidCharacters 
public resetReplaceInvalidCharacters(): void
resetReplication 
public resetReplication(): void
resetStorageSerializationPolicy 
public resetStorageSerializationPolicy(): void
resetSuspendTaskAfterNumFailures 
public resetSuspendTaskAfterNumFailures(): void
resetTaskAutoRetryAttempts 
public resetTaskAutoRetryAttempts(): void
resetTraceLevel 
public resetTraceLevel(): void
resetUserTaskManagedInitialWarehouseSize 
public resetUserTaskManagedInitialWarehouseSize(): void
resetUserTaskMinimumTriggerIntervalInSeconds 
public resetUserTaskMinimumTriggerIntervalInSeconds(): void
resetUserTaskTimeoutMs 
public resetUserTaskTimeoutMs(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a Database resource upon running "cdktf plan ".
isConstruct 
import { database } from '@cdktf/provider-snowflake'

database.Database.isConstruct(x: any)

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: any

Any object.

isTerraformElement 
import { database } from '@cdktf/provider-snowflake'

database.Database.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { database } from '@cdktf/provider-snowflake'

database.Database.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { database } from '@cdktf/provider-snowflake'

database.Database.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

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

importFromIdRequired
  • Type: string

The id of the existing Database that should be imported.

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

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
fullyQualifiedName string No description.
replication DatabaseReplicationOutputReference No description.
catalogInput string No description.
commentInput string No description.
dataRetentionTimeInDaysInput number No description.
defaultDdlCollationInput string No description.
dropPublicSchemaOnCreationInput boolean | cdktf.IResolvable No description.
enableConsoleOutputInput boolean | cdktf.IResolvable No description.
externalVolumeInput string No description.
idInput string No description.
isTransientInput boolean | cdktf.IResolvable No description.
logLevelInput string No description.
maxDataExtensionTimeInDaysInput number No description.
nameInput string No description.
quotedIdentifiersIgnoreCaseInput boolean | cdktf.IResolvable No description.
replaceInvalidCharactersInput boolean | cdktf.IResolvable No description.
replicationInput DatabaseReplication No description.
storageSerializationPolicyInput string No description.
suspendTaskAfterNumFailuresInput number No description.
taskAutoRetryAttemptsInput number No description.
traceLevelInput string No description.
userTaskManagedInitialWarehouseSizeInput string No description.
userTaskMinimumTriggerIntervalInSecondsInput number No description.
userTaskTimeoutMsInput number No description.
catalog string No description.
comment string No description.
dataRetentionTimeInDays number No description.
defaultDdlCollation string No description.
dropPublicSchemaOnCreation boolean | cdktf.IResolvable No description.
enableConsoleOutput boolean | cdktf.IResolvable No description.
externalVolume string No description.
id string No description.
isTransient boolean | cdktf.IResolvable No description.
logLevel string No description.
maxDataExtensionTimeInDays number No description.
name string No description.
quotedIdentifiersIgnoreCase boolean | cdktf.IResolvable No description.
replaceInvalidCharacters boolean | cdktf.IResolvable No description.
storageSerializationPolicy string No description.
suspendTaskAfterNumFailures number No description.
taskAutoRetryAttempts number No description.
traceLevel string No description.
userTaskManagedInitialWarehouseSize string No description.
userTaskMinimumTriggerIntervalInSeconds number No description.
userTaskTimeoutMs number No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
fullyQualifiedNameRequired 
public readonly fullyQualifiedName: string;
  • Type: string
replicationRequired 
public readonly replication: DatabaseReplicationOutputReference;
catalogInputOptional 
public readonly catalogInput: string;
  • Type: string
commentInputOptional 
public readonly commentInput: string;
  • Type: string
dataRetentionTimeInDaysInputOptional 
public readonly dataRetentionTimeInDaysInput: number;
  • Type: number
defaultDdlCollationInputOptional 
public readonly defaultDdlCollationInput: string;
  • Type: string
dropPublicSchemaOnCreationInputOptional 
public readonly dropPublicSchemaOnCreationInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enableConsoleOutputInputOptional 
public readonly enableConsoleOutputInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
externalVolumeInputOptional 
public readonly externalVolumeInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
isTransientInputOptional 
public readonly isTransientInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
logLevelInputOptional 
public readonly logLevelInput: string;
  • Type: string
maxDataExtensionTimeInDaysInputOptional 
public readonly maxDataExtensionTimeInDaysInput: number;
  • Type: number
nameInputOptional 
public readonly nameInput: string;
  • Type: string
quotedIdentifiersIgnoreCaseInputOptional 
public readonly quotedIdentifiersIgnoreCaseInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
replaceInvalidCharactersInputOptional 
public readonly replaceInvalidCharactersInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
replicationInputOptional 
public readonly replicationInput: DatabaseReplication;
storageSerializationPolicyInputOptional 
public readonly storageSerializationPolicyInput: string;
  • Type: string
suspendTaskAfterNumFailuresInputOptional 
public readonly suspendTaskAfterNumFailuresInput: number;
  • Type: number
taskAutoRetryAttemptsInputOptional 
public readonly taskAutoRetryAttemptsInput: number;
  • Type: number
traceLevelInputOptional 
public readonly traceLevelInput: string;
  • Type: string
userTaskManagedInitialWarehouseSizeInputOptional 
public readonly userTaskManagedInitialWarehouseSizeInput: string;
  • Type: string
userTaskMinimumTriggerIntervalInSecondsInputOptional 
public readonly userTaskMinimumTriggerIntervalInSecondsInput: number;
  • Type: number
userTaskTimeoutMsInputOptional 
public readonly userTaskTimeoutMsInput: number;
  • Type: number
catalogRequired 
public readonly catalog: string;
  • Type: string
commentRequired 
public readonly comment: string;
  • Type: string
dataRetentionTimeInDaysRequired 
public readonly dataRetentionTimeInDays: number;
  • Type: number
defaultDdlCollationRequired 
public readonly defaultDdlCollation: string;
  • Type: string
dropPublicSchemaOnCreationRequired 
public readonly dropPublicSchemaOnCreation: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enableConsoleOutputRequired 
public readonly enableConsoleOutput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
externalVolumeRequired 
public readonly externalVolume: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
isTransientRequired 
public readonly isTransient: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
logLevelRequired 
public readonly logLevel: string;
  • Type: string
maxDataExtensionTimeInDaysRequired 
public readonly maxDataExtensionTimeInDays: number;
  • Type: number
nameRequired 
public readonly name: string;
  • Type: string
quotedIdentifiersIgnoreCaseRequired 
public readonly quotedIdentifiersIgnoreCase: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
replaceInvalidCharactersRequired 
public readonly replaceInvalidCharacters: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
storageSerializationPolicyRequired 
public readonly storageSerializationPolicy: string;
  • Type: string
suspendTaskAfterNumFailuresRequired 
public readonly suspendTaskAfterNumFailures: number;
  • Type: number
taskAutoRetryAttemptsRequired 
public readonly taskAutoRetryAttempts: number;
  • Type: number
traceLevelRequired 
public readonly traceLevel: string;
  • Type: string
userTaskManagedInitialWarehouseSizeRequired 
public readonly userTaskManagedInitialWarehouseSize: string;
  • Type: string
userTaskMinimumTriggerIntervalInSecondsRequired 
public readonly userTaskMinimumTriggerIntervalInSeconds: number;
  • Type: number
userTaskTimeoutMsRequired 
public readonly userTaskTimeoutMs: number;
  • Type: number

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

DatabaseConfig

Initializer 

import { database } from '@cdktf/provider-snowflake'

const databaseConfig: database.DatabaseConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
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 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.
defaultDdlCollation string Specifies a default collation specification for all schemas and tables added to the database.
dropPublicSchemaOnCreation boolean | cdktf.IResolvable Specifies whether to drop public schema on creation or not.
enableConsoleOutput boolean | cdktf.IResolvable 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.1/docs/resources/database#id Database#id}.
isTransient boolean | cdktf.IResolvable 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 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.
quotedIdentifiersIgnoreCase boolean | cdktf.IResolvable If true, the case of quoted identifiers is ignored. For more information, see QUOTED_IDENTIFIERS_IGNORE_CASE.
replaceInvalidCharacters boolean | cdktf.IResolvable Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�) in query results for an Iceberg table.
replication DatabaseReplication replication block.
storageSerializationPolicy string The storage serialization policy for Iceberg tables that use Snowflake as the catalog.
suspendTaskAfterNumFailures number How many times a task must fail in a row before it is automatically suspended.
taskAutoRetryAttempts number 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 number Minimum amount of time between Triggered Task executions in seconds.
userTaskTimeoutMs number User task execution timeout in milliseconds. For more information, see USER_TASK_TIMEOUT_MS.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
nameRequired 
public readonly 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.1/docs/resources/database#name Database#name}

catalogOptional 
public readonly 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.1/docs/resources/database#catalog Database#catalog}

commentOptional 
public readonly 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.1/docs/resources/database#comment Database#comment}

dataRetentionTimeInDaysOptional 
public readonly dataRetentionTimeInDays: number;
  • Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/database#data_retention_time_in_days Database#data_retention_time_in_days}

defaultDdlCollationOptional 
public readonly 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.1/docs/resources/database#default_ddl_collation Database#default_ddl_collation}

dropPublicSchemaOnCreationOptional 
public readonly dropPublicSchemaOnCreation: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Specifies whether to drop public schema on creation or not.

Modifying the parameter after database is already created won't have any effect.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/database#drop_public_schema_on_creation Database#drop_public_schema_on_creation}

enableConsoleOutputOptional 
public readonly enableConsoleOutput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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.1/docs/resources/database#enable_console_output Database#enable_console_output}

externalVolumeOptional 
public readonly 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.1/docs/resources/database#external_volume Database#external_volume}

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/database#id Database#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 
public readonly isTransient: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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.1/docs/resources/database#is_transient Database#is_transient}

logLevelOptional 
public readonly 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.1/docs/resources/database#log_level Database#log_level}

maxDataExtensionTimeInDaysOptional 
public readonly maxDataExtensionTimeInDays: number;
  • Type: 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 MAX_DATA_EXTENSION_TIME_IN_DAYS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/database#max_data_extension_time_in_days Database#max_data_extension_time_in_days}

quotedIdentifiersIgnoreCaseOptional 
public readonly quotedIdentifiersIgnoreCase: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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.1/docs/resources/database#quoted_identifiers_ignore_case Database#quoted_identifiers_ignore_case}

replaceInvalidCharactersOptional 
public readonly replaceInvalidCharacters: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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.1/docs/resources/database#replace_invalid_characters Database#replace_invalid_characters}

replicationOptional 
public readonly replication: DatabaseReplication;

replication block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/database#replication Database#replication}

storageSerializationPolicyOptional 
public readonly 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.1/docs/resources/database#storage_serialization_policy Database#storage_serialization_policy}

suspendTaskAfterNumFailuresOptional 
public readonly suspendTaskAfterNumFailures: number;
  • Type: number

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.1/docs/resources/database#suspend_task_after_num_failures Database#suspend_task_after_num_failures}

taskAutoRetryAttemptsOptional 
public readonly taskAutoRetryAttempts: number;
  • Type: number

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.1/docs/resources/database#task_auto_retry_attempts Database#task_auto_retry_attempts}

traceLevelOptional 
public readonly 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.1/docs/resources/database#trace_level Database#trace_level}

userTaskManagedInitialWarehouseSizeOptional 
public readonly 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.1/docs/resources/database#user_task_managed_initial_warehouse_size Database#user_task_managed_initial_warehouse_size}

userTaskMinimumTriggerIntervalInSecondsOptional 
public readonly userTaskMinimumTriggerIntervalInSeconds: number;
  • Type: number

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.1/docs/resources/database#user_task_minimum_trigger_interval_in_seconds Database#user_task_minimum_trigger_interval_in_seconds}

userTaskTimeoutMsOptional 
public readonly userTaskTimeoutMs: number;
  • Type: number

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.1/docs/resources/database#user_task_timeout_ms Database#user_task_timeout_ms}

DatabaseReplication

Initializer 

import { database } from '@cdktf/provider-snowflake'

const databaseReplication: database.DatabaseReplication = { ... }

Properties

Name Type Description
enableToAccount cdktf.IResolvable | DatabaseReplicationEnableToAccount[] enable_to_account block.
ignoreEditionCheck boolean | cdktf.IResolvable Allows replicating data to accounts on lower editions in either of the following scenarios: 1.
enableToAccountRequired 
public readonly enableToAccount: IResolvable | DatabaseReplicationEnableToAccount[];

enable_to_account block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/database#enable_to_account Database#enable_to_account}

ignoreEditionCheckOptional 
public readonly ignoreEditionCheck: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/database#ignore_edition_check Database#ignore_edition_check}

DatabaseReplicationEnableToAccount

Initializer 

import { database } from '@cdktf/provider-snowflake'

const databaseReplicationEnableToAccount: database.DatabaseReplicationEnableToAccount = { ... }

Properties

Name Type Description
accountIdentifier string Specifies account identifier for which replication should be enabled.
withFailover boolean | cdktf.IResolvable Specifies if failover should be enabled for the specified account identifier.
accountIdentifierRequired 
public readonly accountIdentifier: string;
  • Type: string

Specifies account identifier for which replication should be enabled.

The account identifiers should be in the form of "<organization_name>"."<account_name>". For more information about this resource, see docs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/database#account_identifier Database#account_identifier}

withFailoverOptional 
public readonly withFailover: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Specifies if failover should be enabled for the specified account identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/database#with_failover Database#with_failover}

Classes

DatabaseReplicationEnableToAccountList

Initializers 

import { database } from '@cdktf/provider-snowflake'

new database.DatabaseReplicationEnableToAccountList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
allWithMapKey 
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string
computeFqn 
public computeFqn(): string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public get(index: number): DatabaseReplicationEnableToAccountOutputReference
indexRequired
  • Type: number

the index of the item to return.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
internalValue cdktf.IResolvable | DatabaseReplicationEnableToAccount[] No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | DatabaseReplicationEnableToAccount[];

DatabaseReplicationEnableToAccountOutputReference

Initializers 

import { database } from '@cdktf/provider-snowflake'

new database.DatabaseReplicationEnableToAccountOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
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.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetWithFailover No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetWithFailover 
public resetWithFailover(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
accountIdentifierInput string No description.
withFailoverInput boolean | cdktf.IResolvable No description.
accountIdentifier string No description.
withFailover boolean | cdktf.IResolvable No description.
internalValue cdktf.IResolvable | DatabaseReplicationEnableToAccount No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
accountIdentifierInputOptional 
public readonly accountIdentifierInput: string;
  • Type: string
withFailoverInputOptional 
public readonly withFailoverInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
accountIdentifierRequired 
public readonly accountIdentifier: string;
  • Type: string
withFailoverRequired 
public readonly withFailover: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
internalValueOptional 
public readonly internalValue: IResolvable | DatabaseReplicationEnableToAccount;

DatabaseReplicationOutputReference

Initializers 

import { database } from '@cdktf/provider-snowflake'

new database.DatabaseReplicationOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
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.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
putEnableToAccount No description.
resetIgnoreEditionCheck No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

putEnableToAccount 
public putEnableToAccount(value: IResolvable | DatabaseReplicationEnableToAccount[]): void
valueRequired
resetIgnoreEditionCheck 
public resetIgnoreEditionCheck(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
enableToAccount DatabaseReplicationEnableToAccountList No description.
enableToAccountInput cdktf.IResolvable | DatabaseReplicationEnableToAccount[] No description.
ignoreEditionCheckInput boolean | cdktf.IResolvable No description.
ignoreEditionCheck boolean | cdktf.IResolvable No description.
internalValue DatabaseReplication No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
enableToAccountRequired 
public readonly enableToAccount: DatabaseReplicationEnableToAccountList;
enableToAccountInputOptional 
public readonly enableToAccountInput: IResolvable | DatabaseReplicationEnableToAccount[];
ignoreEditionCheckInputOptional 
public readonly ignoreEditionCheckInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
ignoreEditionCheckRequired 
public readonly ignoreEditionCheck: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
internalValueOptional 
public readonly internalValue: DatabaseReplication;