Skip to content

Latest commit

 

History

History
3058 lines (1901 loc) · 150 KB

database.java.md

File metadata and controls

3058 lines (1901 loc) · 150 KB

database Submodule

Constructs

Database

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

Initializers 

import com.hashicorp.cdktf.providers.snowflake.database.Database;

Database.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
//  .catalog(java.lang.String)
//  .comment(java.lang.String)
//  .dataRetentionTimeInDays(java.lang.Number)
//  .defaultDdlCollation(java.lang.String)
//  .dropPublicSchemaOnCreation(java.lang.Boolean)
//  .dropPublicSchemaOnCreation(IResolvable)
//  .enableConsoleOutput(java.lang.Boolean)
//  .enableConsoleOutput(IResolvable)
//  .externalVolume(java.lang.String)
//  .id(java.lang.String)
//  .isTransient(java.lang.Boolean)
//  .isTransient(IResolvable)
//  .logLevel(java.lang.String)
//  .maxDataExtensionTimeInDays(java.lang.Number)
//  .quotedIdentifiersIgnoreCase(java.lang.Boolean)
//  .quotedIdentifiersIgnoreCase(IResolvable)
//  .replaceInvalidCharacters(java.lang.Boolean)
//  .replaceInvalidCharacters(IResolvable)
//  .replication(DatabaseReplication)
//  .storageSerializationPolicy(java.lang.String)
//  .suspendTaskAfterNumFailures(java.lang.Number)
//  .taskAutoRetryAttempts(java.lang.Number)
//  .traceLevel(java.lang.String)
//  .userTaskManagedInitialWarehouseSize(java.lang.String)
//  .userTaskMinimumTriggerIntervalInSeconds(java.lang.Number)
//  .userTaskTimeoutMs(java.lang.Number)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String Specifies the identifier for the database;
catalog java.lang.String The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
comment java.lang.String Specifies a comment for the database.
dataRetentionTimeInDays java.lang.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 java.lang.String Specifies a default collation specification for all schemas and tables added to the database.
dropPublicSchemaOnCreation java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies whether to drop public schema on creation or not.
enableConsoleOutput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If true, enables stdout/stderr fast path logging for anonymous stored procedures.
externalVolume java.lang.String The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/database#id Database#id}.
isTransient java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies the database as transient.
logLevel java.lang.String Specifies the severity level of messages that should be ingested and made available in the active event table.
maxDataExtensionTimeInDays java.lang.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 java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If true, the case of quoted identifiers is ignored. For more information, see QUOTED_IDENTIFIERS_IGNORE_CASE.
replaceInvalidCharacters java.lang.Boolean OR com.hashicorp.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 java.lang.String The storage serialization policy for Iceberg tables that use Snowflake as the catalog.
suspendTaskAfterNumFailures java.lang.Number How many times a task must fail in a row before it is automatically suspended.
taskAutoRetryAttempts java.lang.Number Maximum automatic retries allowed for a user task. For more information, see TASK_AUTO_RETRY_ATTEMPTS.
traceLevel java.lang.String Controls how trace events are ingested into the event table.
userTaskManagedInitialWarehouseSize java.lang.String The initial size of warehouse to use for managed warehouses in the absence of history.
userTaskMinimumTriggerIntervalInSeconds java.lang.Number Minimum amount of time between Triggered Task executions in seconds.
userTaskTimeoutMs java.lang.Number User task execution timeout in milliseconds. For more information, see USER_TASK_TIMEOUT_MS.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
nameRequired
  • Type: java.lang.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.3/docs/resources/database#name Database#name}

catalogOptional
  • Type: java.lang.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.3/docs/resources/database#catalog Database#catalog}

commentOptional
  • Type: java.lang.String

Specifies a comment for the database.

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

dataRetentionTimeInDaysOptional
  • Type: java.lang.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.3/docs/resources/database#data_retention_time_in_days Database#data_retention_time_in_days}

defaultDdlCollationOptional
  • Type: java.lang.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.3/docs/resources/database#default_ddl_collation Database#default_ddl_collation}

dropPublicSchemaOnCreationOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.3/docs/resources/database#drop_public_schema_on_creation Database#drop_public_schema_on_creation}

enableConsoleOutputOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.3/docs/resources/database#enable_console_output Database#enable_console_output}

externalVolumeOptional
  • Type: java.lang.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.3/docs/resources/database#external_volume Database#external_volume}

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/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
  • Type: java.lang.Boolean OR com.hashicorp.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.3/docs/resources/database#is_transient Database#is_transient}

logLevelOptional
  • Type: java.lang.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.3/docs/resources/database#log_level Database#log_level}

maxDataExtensionTimeInDaysOptional
  • Type: java.lang.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.3/docs/resources/database#max_data_extension_time_in_days Database#max_data_extension_time_in_days}

quotedIdentifiersIgnoreCaseOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.3/docs/resources/database#quoted_identifiers_ignore_case Database#quoted_identifiers_ignore_case}

replaceInvalidCharactersOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.3/docs/resources/database#replace_invalid_characters Database#replace_invalid_characters}

replicationOptional

replication block.

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

storageSerializationPolicyOptional
  • Type: java.lang.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.3/docs/resources/database#storage_serialization_policy Database#storage_serialization_policy}

suspendTaskAfterNumFailuresOptional
  • Type: java.lang.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.3/docs/resources/database#suspend_task_after_num_failures Database#suspend_task_after_num_failures}

taskAutoRetryAttemptsOptional
  • Type: java.lang.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.3/docs/resources/database#task_auto_retry_attempts Database#task_auto_retry_attempts}

traceLevelOptional
  • Type: java.lang.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.3/docs/resources/database#trace_level Database#trace_level}

userTaskManagedInitialWarehouseSizeOptional
  • Type: java.lang.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.3/docs/resources/database#user_task_managed_initial_warehouse_size Database#user_task_managed_initial_warehouse_size}

userTaskMinimumTriggerIntervalInSecondsOptional
  • Type: java.lang.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.3/docs/resources/database#user_task_minimum_trigger_interval_in_seconds Database#user_task_minimum_trigger_interval_in_seconds}

userTaskTimeoutMsOptional
  • Type: java.lang.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.3/docs/resources/database#user_task_timeout_ms Database#user_task_timeout_ms}

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 java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

putReplication 
public void putReplication(DatabaseReplication value)
valueRequired
resetCatalog 
public void resetCatalog()
resetComment 
public void resetComment()
resetDataRetentionTimeInDays 
public void resetDataRetentionTimeInDays()
resetDefaultDdlCollation 
public void resetDefaultDdlCollation()
resetDropPublicSchemaOnCreation 
public void resetDropPublicSchemaOnCreation()
resetEnableConsoleOutput 
public void resetEnableConsoleOutput()
resetExternalVolume 
public void resetExternalVolume()
resetId 
public void resetId()
resetIsTransient 
public void resetIsTransient()
resetLogLevel 
public void resetLogLevel()
resetMaxDataExtensionTimeInDays 
public void resetMaxDataExtensionTimeInDays()
resetQuotedIdentifiersIgnoreCase 
public void resetQuotedIdentifiersIgnoreCase()
resetReplaceInvalidCharacters 
public void resetReplaceInvalidCharacters()
resetReplication 
public void resetReplication()
resetStorageSerializationPolicy 
public void resetStorageSerializationPolicy()
resetSuspendTaskAfterNumFailures 
public void resetSuspendTaskAfterNumFailures()
resetTaskAutoRetryAttempts 
public void resetTaskAutoRetryAttempts()
resetTraceLevel 
public void resetTraceLevel()
resetUserTaskManagedInitialWarehouseSize 
public void resetUserTaskManagedInitialWarehouseSize()
resetUserTaskMinimumTriggerIntervalInSeconds 
public void resetUserTaskMinimumTriggerIntervalInSeconds()
resetUserTaskTimeoutMs 
public void 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 Database resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.snowflake.database.Database;

Database.isConstruct(java.lang.Object x)

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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.snowflake.database.Database;

Database.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.snowflake.database.Database;

Database.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.snowflake.database.Database;

Database.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Database.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.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.3/docs/resources/database#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
fullyQualifiedName java.lang.String No description.
replication DatabaseReplicationOutputReference No description.
catalogInput java.lang.String No description.
commentInput java.lang.String No description.
dataRetentionTimeInDaysInput java.lang.Number No description.
defaultDdlCollationInput java.lang.String No description.
dropPublicSchemaOnCreationInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
enableConsoleOutputInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
externalVolumeInput java.lang.String No description.
idInput java.lang.String No description.
isTransientInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
logLevelInput java.lang.String No description.
maxDataExtensionTimeInDaysInput java.lang.Number No description.
nameInput java.lang.String No description.
quotedIdentifiersIgnoreCaseInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
replaceInvalidCharactersInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
replicationInput DatabaseReplication No description.
storageSerializationPolicyInput java.lang.String No description.
suspendTaskAfterNumFailuresInput java.lang.Number No description.
taskAutoRetryAttemptsInput java.lang.Number No description.
traceLevelInput java.lang.String No description.
userTaskManagedInitialWarehouseSizeInput java.lang.String No description.
userTaskMinimumTriggerIntervalInSecondsInput java.lang.Number No description.
userTaskTimeoutMsInput java.lang.Number No description.
catalog java.lang.String No description.
comment java.lang.String No description.
dataRetentionTimeInDays java.lang.Number No description.
defaultDdlCollation java.lang.String No description.
dropPublicSchemaOnCreation java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
enableConsoleOutput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
externalVolume java.lang.String No description.
id java.lang.String No description.
isTransient java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
logLevel java.lang.String No description.
maxDataExtensionTimeInDays java.lang.Number No description.
name java.lang.String No description.
quotedIdentifiersIgnoreCase java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
replaceInvalidCharacters java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
storageSerializationPolicy java.lang.String No description.
suspendTaskAfterNumFailures java.lang.Number No description.
taskAutoRetryAttempts java.lang.Number No description.
traceLevel java.lang.String No description.
userTaskManagedInitialWarehouseSize java.lang.String No description.
userTaskMinimumTriggerIntervalInSeconds java.lang.Number No description.
userTaskTimeoutMs java.lang.Number No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
fullyQualifiedNameRequired 
public java.lang.String getFullyQualifiedName();
  • Type: java.lang.String
replicationRequired 
public DatabaseReplicationOutputReference getReplication();
catalogInputOptional 
public java.lang.String getCatalogInput();
  • Type: java.lang.String
commentInputOptional 
public java.lang.String getCommentInput();
  • Type: java.lang.String
dataRetentionTimeInDaysInputOptional 
public java.lang.Number getDataRetentionTimeInDaysInput();
  • Type: java.lang.Number
defaultDdlCollationInputOptional 
public java.lang.String getDefaultDdlCollationInput();
  • Type: java.lang.String
dropPublicSchemaOnCreationInputOptional 
public java.lang.Object getDropPublicSchemaOnCreationInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
enableConsoleOutputInputOptional 
public java.lang.Object getEnableConsoleOutputInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
externalVolumeInputOptional 
public java.lang.String getExternalVolumeInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
isTransientInputOptional 
public java.lang.Object getIsTransientInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
logLevelInputOptional 
public java.lang.String getLogLevelInput();
  • Type: java.lang.String
maxDataExtensionTimeInDaysInputOptional 
public java.lang.Number getMaxDataExtensionTimeInDaysInput();
  • Type: java.lang.Number
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
quotedIdentifiersIgnoreCaseInputOptional 
public java.lang.Object getQuotedIdentifiersIgnoreCaseInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
replaceInvalidCharactersInputOptional 
public java.lang.Object getReplaceInvalidCharactersInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
replicationInputOptional 
public DatabaseReplication getReplicationInput();
storageSerializationPolicyInputOptional 
public java.lang.String getStorageSerializationPolicyInput();
  • Type: java.lang.String
suspendTaskAfterNumFailuresInputOptional 
public java.lang.Number getSuspendTaskAfterNumFailuresInput();
  • Type: java.lang.Number
taskAutoRetryAttemptsInputOptional 
public java.lang.Number getTaskAutoRetryAttemptsInput();
  • Type: java.lang.Number
traceLevelInputOptional 
public java.lang.String getTraceLevelInput();
  • Type: java.lang.String
userTaskManagedInitialWarehouseSizeInputOptional 
public java.lang.String getUserTaskManagedInitialWarehouseSizeInput();
  • Type: java.lang.String
userTaskMinimumTriggerIntervalInSecondsInputOptional 
public java.lang.Number getUserTaskMinimumTriggerIntervalInSecondsInput();
  • Type: java.lang.Number
userTaskTimeoutMsInputOptional 
public java.lang.Number getUserTaskTimeoutMsInput();
  • Type: java.lang.Number
catalogRequired 
public java.lang.String getCatalog();
  • Type: java.lang.String
commentRequired 
public java.lang.String getComment();
  • Type: java.lang.String
dataRetentionTimeInDaysRequired 
public java.lang.Number getDataRetentionTimeInDays();
  • Type: java.lang.Number
defaultDdlCollationRequired 
public java.lang.String getDefaultDdlCollation();
  • Type: java.lang.String
dropPublicSchemaOnCreationRequired 
public java.lang.Object getDropPublicSchemaOnCreation();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
enableConsoleOutputRequired 
public java.lang.Object getEnableConsoleOutput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
externalVolumeRequired 
public java.lang.String getExternalVolume();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
isTransientRequired 
public java.lang.Object getIsTransient();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
logLevelRequired 
public java.lang.String getLogLevel();
  • Type: java.lang.String
maxDataExtensionTimeInDaysRequired 
public java.lang.Number getMaxDataExtensionTimeInDays();
  • Type: java.lang.Number
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
quotedIdentifiersIgnoreCaseRequired 
public java.lang.Object getQuotedIdentifiersIgnoreCase();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
replaceInvalidCharactersRequired 
public java.lang.Object getReplaceInvalidCharacters();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
storageSerializationPolicyRequired 
public java.lang.String getStorageSerializationPolicy();
  • Type: java.lang.String
suspendTaskAfterNumFailuresRequired 
public java.lang.Number getSuspendTaskAfterNumFailures();
  • Type: java.lang.Number
taskAutoRetryAttemptsRequired 
public java.lang.Number getTaskAutoRetryAttempts();
  • Type: java.lang.Number
traceLevelRequired 
public java.lang.String getTraceLevel();
  • Type: java.lang.String
userTaskManagedInitialWarehouseSizeRequired 
public java.lang.String getUserTaskManagedInitialWarehouseSize();
  • Type: java.lang.String
userTaskMinimumTriggerIntervalInSecondsRequired 
public java.lang.Number getUserTaskMinimumTriggerIntervalInSeconds();
  • Type: java.lang.Number
userTaskTimeoutMsRequired 
public java.lang.Number getUserTaskTimeoutMs();
  • Type: java.lang.Number

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

DatabaseConfig

Initializer 

import com.hashicorp.cdktf.providers.snowflake.database.DatabaseConfig;

DatabaseConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
//  .catalog(java.lang.String)
//  .comment(java.lang.String)
//  .dataRetentionTimeInDays(java.lang.Number)
//  .defaultDdlCollation(java.lang.String)
//  .dropPublicSchemaOnCreation(java.lang.Boolean)
//  .dropPublicSchemaOnCreation(IResolvable)
//  .enableConsoleOutput(java.lang.Boolean)
//  .enableConsoleOutput(IResolvable)
//  .externalVolume(java.lang.String)
//  .id(java.lang.String)
//  .isTransient(java.lang.Boolean)
//  .isTransient(IResolvable)
//  .logLevel(java.lang.String)
//  .maxDataExtensionTimeInDays(java.lang.Number)
//  .quotedIdentifiersIgnoreCase(java.lang.Boolean)
//  .quotedIdentifiersIgnoreCase(IResolvable)
//  .replaceInvalidCharacters(java.lang.Boolean)
//  .replaceInvalidCharacters(IResolvable)
//  .replication(DatabaseReplication)
//  .storageSerializationPolicy(java.lang.String)
//  .suspendTaskAfterNumFailures(java.lang.Number)
//  .taskAutoRetryAttempts(java.lang.Number)
//  .traceLevel(java.lang.String)
//  .userTaskManagedInitialWarehouseSize(java.lang.String)
//  .userTaskMinimumTriggerIntervalInSeconds(java.lang.Number)
//  .userTaskTimeoutMs(java.lang.Number)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String Specifies the identifier for the database;
catalog java.lang.String The database parameter that specifies the default catalog to use for Iceberg tables. For more information, see CATALOG.
comment java.lang.String Specifies a comment for the database.
dataRetentionTimeInDays java.lang.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 java.lang.String Specifies a default collation specification for all schemas and tables added to the database.
dropPublicSchemaOnCreation java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies whether to drop public schema on creation or not.
enableConsoleOutput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If true, enables stdout/stderr fast path logging for anonymous stored procedures.
externalVolume java.lang.String The database parameter that specifies the default external volume to use for Iceberg tables. For more information, see EXTERNAL_VOLUME.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/database#id Database#id}.
isTransient java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies the database as transient.
logLevel java.lang.String Specifies the severity level of messages that should be ingested and made available in the active event table.
maxDataExtensionTimeInDays java.lang.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 java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If true, the case of quoted identifiers is ignored. For more information, see QUOTED_IDENTIFIERS_IGNORE_CASE.
replaceInvalidCharacters java.lang.Boolean OR com.hashicorp.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 java.lang.String The storage serialization policy for Iceberg tables that use Snowflake as the catalog.
suspendTaskAfterNumFailures java.lang.Number How many times a task must fail in a row before it is automatically suspended.
taskAutoRetryAttempts java.lang.Number Maximum automatic retries allowed for a user task. For more information, see TASK_AUTO_RETRY_ATTEMPTS.
traceLevel java.lang.String Controls how trace events are ingested into the event table.
userTaskManagedInitialWarehouseSize java.lang.String The initial size of warehouse to use for managed warehouses in the absence of history.
userTaskMinimumTriggerIntervalInSeconds java.lang.Number Minimum amount of time between Triggered Task executions in seconds.
userTaskTimeoutMs java.lang.Number User task execution timeout in milliseconds. For more information, see USER_TASK_TIMEOUT_MS.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
nameRequired 
public java.lang.String getName();
  • Type: java.lang.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.3/docs/resources/database#name Database#name}

catalogOptional 
public java.lang.String getCatalog();
  • Type: java.lang.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.3/docs/resources/database#catalog Database#catalog}

commentOptional 
public java.lang.String getComment();
  • Type: java.lang.String

Specifies a comment for the database.

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

dataRetentionTimeInDaysOptional 
public java.lang.Number getDataRetentionTimeInDays();
  • Type: java.lang.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.3/docs/resources/database#data_retention_time_in_days Database#data_retention_time_in_days}

defaultDdlCollationOptional 
public java.lang.String getDefaultDdlCollation();
  • Type: java.lang.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.3/docs/resources/database#default_ddl_collation Database#default_ddl_collation}

dropPublicSchemaOnCreationOptional 
public java.lang.Object getDropPublicSchemaOnCreation();
  • Type: java.lang.Boolean OR com.hashicorp.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.3/docs/resources/database#drop_public_schema_on_creation Database#drop_public_schema_on_creation}

enableConsoleOutputOptional 
public java.lang.Object getEnableConsoleOutput();
  • Type: java.lang.Boolean OR com.hashicorp.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.3/docs/resources/database#enable_console_output Database#enable_console_output}

externalVolumeOptional 
public java.lang.String getExternalVolume();
  • Type: java.lang.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.3/docs/resources/database#external_volume Database#external_volume}

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/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 java.lang.Object getIsTransient();
  • Type: java.lang.Boolean OR com.hashicorp.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.3/docs/resources/database#is_transient Database#is_transient}

logLevelOptional 
public java.lang.String getLogLevel();
  • Type: java.lang.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.3/docs/resources/database#log_level Database#log_level}

maxDataExtensionTimeInDaysOptional 
public java.lang.Number getMaxDataExtensionTimeInDays();
  • Type: java.lang.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.3/docs/resources/database#max_data_extension_time_in_days Database#max_data_extension_time_in_days}

quotedIdentifiersIgnoreCaseOptional 
public java.lang.Object getQuotedIdentifiersIgnoreCase();
  • Type: java.lang.Boolean OR com.hashicorp.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.3/docs/resources/database#quoted_identifiers_ignore_case Database#quoted_identifiers_ignore_case}

replaceInvalidCharactersOptional 
public java.lang.Object getReplaceInvalidCharacters();
  • Type: java.lang.Boolean OR com.hashicorp.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.3/docs/resources/database#replace_invalid_characters Database#replace_invalid_characters}

replicationOptional 
public DatabaseReplication getReplication();

replication block.

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

storageSerializationPolicyOptional 
public java.lang.String getStorageSerializationPolicy();
  • Type: java.lang.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.3/docs/resources/database#storage_serialization_policy Database#storage_serialization_policy}

suspendTaskAfterNumFailuresOptional 
public java.lang.Number getSuspendTaskAfterNumFailures();
  • Type: java.lang.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.3/docs/resources/database#suspend_task_after_num_failures Database#suspend_task_after_num_failures}

taskAutoRetryAttemptsOptional 
public java.lang.Number getTaskAutoRetryAttempts();
  • Type: java.lang.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.3/docs/resources/database#task_auto_retry_attempts Database#task_auto_retry_attempts}

traceLevelOptional 
public java.lang.String getTraceLevel();
  • Type: java.lang.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.3/docs/resources/database#trace_level Database#trace_level}

userTaskManagedInitialWarehouseSizeOptional 
public java.lang.String getUserTaskManagedInitialWarehouseSize();
  • Type: java.lang.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.3/docs/resources/database#user_task_managed_initial_warehouse_size Database#user_task_managed_initial_warehouse_size}

userTaskMinimumTriggerIntervalInSecondsOptional 
public java.lang.Number getUserTaskMinimumTriggerIntervalInSeconds();
  • Type: java.lang.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.3/docs/resources/database#user_task_minimum_trigger_interval_in_seconds Database#user_task_minimum_trigger_interval_in_seconds}

userTaskTimeoutMsOptional 
public java.lang.Number getUserTaskTimeoutMs();
  • Type: java.lang.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.3/docs/resources/database#user_task_timeout_ms Database#user_task_timeout_ms}

DatabaseReplication

Initializer 

import com.hashicorp.cdktf.providers.snowflake.database.DatabaseReplication;

DatabaseReplication.builder()
    .enableToAccount(IResolvable)
    .enableToAccount(java.util.List<DatabaseReplicationEnableToAccount>)
//  .ignoreEditionCheck(java.lang.Boolean)
//  .ignoreEditionCheck(IResolvable)
    .build();

Properties

Name Type Description
enableToAccount com.hashicorp.cdktf.IResolvable OR java.util.List<DatabaseReplicationEnableToAccount> enable_to_account block.
ignoreEditionCheck java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Allows replicating data to accounts on lower editions in either of the following scenarios: 1.
enableToAccountRequired 
public java.lang.Object getEnableToAccount();

enable_to_account block.

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

ignoreEditionCheckOptional 
public java.lang.Object getIgnoreEditionCheck();
  • Type: java.lang.Boolean OR com.hashicorp.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.3/docs/resources/database#ignore_edition_check Database#ignore_edition_check}

DatabaseReplicationEnableToAccount

Initializer 

import com.hashicorp.cdktf.providers.snowflake.database.DatabaseReplicationEnableToAccount;

DatabaseReplicationEnableToAccount.builder()
    .accountIdentifier(java.lang.String)
//  .withFailover(java.lang.Boolean)
//  .withFailover(IResolvable)
    .build();

Properties

Name Type Description
accountIdentifier java.lang.String Specifies account identifier for which replication should be enabled.
withFailover java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies if failover should be enabled for the specified account identifier.
accountIdentifierRequired 
public java.lang.String getAccountIdentifier();
  • Type: java.lang.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.3/docs/resources/database#account_identifier Database#account_identifier}

withFailoverOptional 
public java.lang.Object getWithFailover();
  • Type: java.lang.Boolean OR com.hashicorp.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.3/docs/resources/database#with_failover Database#with_failover}

Classes

DatabaseReplicationEnableToAccountList

Initializers 

import com.hashicorp.cdktf.providers.snowflake.database.DatabaseReplicationEnableToAccountList;

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

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: java.lang.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 DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName)

Creating an iterator for this complex list.

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

mapKeyAttributeNameRequired
  • Type: java.lang.String
computeFqn 
public java.lang.String computeFqn()
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public DatabaseReplicationEnableToAccountOutputReference get(java.lang.Number index)
indexRequired
  • Type: java.lang.Number

the index of the item to return.

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR java.util.List<DatabaseReplicationEnableToAccount> No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();

DatabaseReplicationEnableToAccountOutputReference

Initializers 

import com.hashicorp.cdktf.providers.snowflake.database.DatabaseReplicationEnableToAccountOutputReference;

new DatabaseReplicationEnableToAccountOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
complexObjectIndex java.lang.Number the index of this item in the list.
complexObjectIsFromSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: java.lang.Number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: java.lang.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 java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetWithFailover 
public void resetWithFailover()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
accountIdentifierInput java.lang.String No description.
withFailoverInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
accountIdentifier java.lang.String No description.
withFailover java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
internalValue com.hashicorp.cdktf.IResolvable OR DatabaseReplicationEnableToAccount No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
accountIdentifierInputOptional 
public java.lang.String getAccountIdentifierInput();
  • Type: java.lang.String
withFailoverInputOptional 
public java.lang.Object getWithFailoverInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
accountIdentifierRequired 
public java.lang.String getAccountIdentifier();
  • Type: java.lang.String
withFailoverRequired 
public java.lang.Object getWithFailover();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
internalValueOptional 
public java.lang.Object getInternalValue();

DatabaseReplicationOutputReference

Initializers 

import com.hashicorp.cdktf.providers.snowflake.database.DatabaseReplicationOutputReference;

new DatabaseReplicationOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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 java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

putEnableToAccount 
public void putEnableToAccount(IResolvable OR java.util.List<DatabaseReplicationEnableToAccount> value)
valueRequired
resetIgnoreEditionCheck 
public void resetIgnoreEditionCheck()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
enableToAccount DatabaseReplicationEnableToAccountList No description.
enableToAccountInput com.hashicorp.cdktf.IResolvable OR java.util.List<DatabaseReplicationEnableToAccount> No description.
ignoreEditionCheckInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
ignoreEditionCheck java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
internalValue DatabaseReplication No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
enableToAccountRequired 
public DatabaseReplicationEnableToAccountList getEnableToAccount();
enableToAccountInputOptional 
public java.lang.Object getEnableToAccountInput();
ignoreEditionCheckInputOptional 
public java.lang.Object getIgnoreEditionCheckInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
ignoreEditionCheckRequired 
public java.lang.Object getIgnoreEditionCheck();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
internalValueOptional 
public DatabaseReplication getInternalValue();