Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database snowflake_database}.
using HashiCorp.Cdktf.Providers.Snowflake;
new Database(Construct Scope, string Id, DatabaseConfig Config);
Name | Type | Description |
---|---|---|
Scope |
Constructs.Construct |
The scope in which to define this construct. |
Id |
string |
The scoped construct ID. |
Config |
DatabaseConfig |
No description. |
- Type: Constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: DatabaseConfig
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". |
PutReplicationConfiguration |
No description. |
ResetComment |
No description. |
ResetDataRetentionTimeInDays |
No description. |
ResetFromDatabase |
No description. |
ResetFromReplica |
No description. |
ResetFromShare |
No description. |
ResetId |
No description. |
ResetIsTransient |
No description. |
ResetReplicationConfiguration |
No description. |
private string ToString()
Returns a string representation of this construct.
private void AddOverride(string Path, object Value)
- Type: string
- Type: object
private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
private object ToHclTerraform()
private object ToMetadata()
private object ToTerraform()
Adds this resource to the terraform JSON output.
private void AddMoveTarget(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.
- Type: string
The string move target that will correspond to this resource.
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private object HasResourceMove()
private void ImportFrom(string Id, TerraformProvider Provider = null)
- Type: string
- Type: HashiCorp.Cdktf.TerraformProvider
private IResolvable InterpolationForAttribute(string TerraformAttribute)
- Type: string
private void MoveFromId(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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
private void MoveTo(string MoveTarget, object Index = null)
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: object
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
private void MoveToId(string Id)
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
private void PutReplicationConfiguration(DatabaseReplicationConfiguration Value)
private void ResetComment()
private void ResetDataRetentionTimeInDays()
private void ResetFromDatabase()
private void ResetFromReplica()
private void ResetFromShare()
private void ResetId()
private void ResetIsTransient()
private void ResetReplicationConfiguration()
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 ". |
using HashiCorp.Cdktf.Providers.Snowflake;
Database.IsConstruct(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.
- Type: object
Any object.
using HashiCorp.Cdktf.Providers.Snowflake;
Database.IsTerraformElement(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Snowflake;
Database.IsTerraformResource(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Snowflake;
Database.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);
Generates CDKTF code for importing a Database resource upon running "cdktf plan ".
- Type: Constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the Database to import.
- Type: string
The id of the existing Database that should be imported.
Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database#import import section} in the documentation of this resource for the id to use
- Type: HashiCorp.Cdktf.TerraformProvider
? Optional instance of the provider where the Database to import is found.
Name | Type | Description |
---|---|---|
Node |
Constructs.Node |
The tree node. |
CdktfStack |
HashiCorp.Cdktf.TerraformStack |
No description. |
Fqn |
string |
No description. |
FriendlyUniqueId |
string |
No description. |
TerraformMetaArguments |
System.Collections.Generic.IDictionary<string, object> |
No description. |
TerraformResourceType |
string |
No description. |
TerraformGeneratorMetadata |
HashiCorp.Cdktf.TerraformProviderGeneratorMetadata |
No description. |
Connection |
object |
No description. |
Count |
object |
No description. |
DependsOn |
string[] |
No description. |
ForEach |
HashiCorp.Cdktf.ITerraformIterator |
No description. |
Lifecycle |
HashiCorp.Cdktf.TerraformResourceLifecycle |
No description. |
Provider |
HashiCorp.Cdktf.TerraformProvider |
No description. |
Provisioners |
object[] |
No description. |
ReplicationConfiguration |
DatabaseReplicationConfigurationOutputReference |
No description. |
CommentInput |
string |
No description. |
DataRetentionTimeInDaysInput |
double |
No description. |
FromDatabaseInput |
string |
No description. |
FromReplicaInput |
string |
No description. |
FromShareInput |
System.Collections.Generic.IDictionary<string, string> |
No description. |
IdInput |
string |
No description. |
IsTransientInput |
object |
No description. |
NameInput |
string |
No description. |
ReplicationConfigurationInput |
DatabaseReplicationConfiguration |
No description. |
Comment |
string |
No description. |
DataRetentionTimeInDays |
double |
No description. |
FromDatabase |
string |
No description. |
FromReplica |
string |
No description. |
FromShare |
System.Collections.Generic.IDictionary<string, string> |
No description. |
Id |
string |
No description. |
IsTransient |
object |
No description. |
Name |
string |
No description. |
public Node Node { get; }
- Type: Constructs.Node
The tree node.
public TerraformStack CdktfStack { get; }
- Type: HashiCorp.Cdktf.TerraformStack
public string Fqn { get; }
- Type: string
public string FriendlyUniqueId { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
- Type: System.Collections.Generic.IDictionary<string, object>
public string TerraformResourceType { get; }
- Type: string
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
- Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
public object Connection { get; }
- Type: object
public object Count { get; }
- Type: object
public string[] DependsOn { get; }
- Type: string[]
public ITerraformIterator ForEach { get; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; }
- Type: object[]
public DatabaseReplicationConfigurationOutputReference ReplicationConfiguration { get; }
public string CommentInput { get; }
- Type: string
public double DataRetentionTimeInDaysInput { get; }
- Type: double
public string FromDatabaseInput { get; }
- Type: string
public string FromReplicaInput { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, string> FromShareInput { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string IdInput { get; }
- Type: string
public object IsTransientInput { get; }
- Type: object
public string NameInput { get; }
- Type: string
public DatabaseReplicationConfiguration ReplicationConfigurationInput { get; }
public string Comment { get; }
- Type: string
public double DataRetentionTimeInDays { get; }
- Type: double
public string FromDatabase { get; }
- Type: string
public string FromReplica { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, string> FromShare { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string Id { get; }
- Type: string
public object IsTransient { get; }
- Type: object
public string Name { get; }
- Type: string
Name | Type | Description |
---|---|---|
TfResourceType |
string |
No description. |
public string TfResourceType { get; }
- Type: string
using HashiCorp.Cdktf.Providers.Snowflake;
new DatabaseConfig {
object Connection = null,
object Count = null,
ITerraformDependable[] DependsOn = null,
ITerraformIterator ForEach = null,
TerraformResourceLifecycle Lifecycle = null,
TerraformProvider Provider = null,
object[] Provisioners = null,
string Name,
string Comment = null,
double DataRetentionTimeInDays = null,
string FromDatabase = null,
string FromReplica = null,
System.Collections.Generic.IDictionary<string, string> FromShare = null,
string Id = null,
object IsTransient = null,
DatabaseReplicationConfiguration ReplicationConfiguration = null
};
Name | Type | Description |
---|---|---|
Connection |
object |
No description. |
Count |
object |
No description. |
DependsOn |
HashiCorp.Cdktf.ITerraformDependable[] |
No description. |
ForEach |
HashiCorp.Cdktf.ITerraformIterator |
No description. |
Lifecycle |
HashiCorp.Cdktf.TerraformResourceLifecycle |
No description. |
Provider |
HashiCorp.Cdktf.TerraformProvider |
No description. |
Provisioners |
object[] |
No description. |
Name |
string |
Specifies the identifier for the database; must be unique for your account. |
Comment |
string |
Specifies a comment for the database. |
DataRetentionTimeInDays |
double |
Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. |
FromDatabase |
string |
Specify a database to create a clone from. |
FromReplica |
string |
Specify a fully-qualified path to a database to create a replica from. |
FromShare |
System.Collections.Generic.IDictionary<string, string> |
Specify a provider and a share in this map to create a database from a share. |
Id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database#id Database#id}. |
IsTransient |
object |
Specifies a database as transient. |
ReplicationConfiguration |
DatabaseReplicationConfiguration |
replication_configuration block. |
public object Connection { get; set; }
- Type: object
public object Count { get; set; }
- Type: object
public ITerraformDependable[] DependsOn { get; set; }
- Type: HashiCorp.Cdktf.ITerraformDependable[]
public ITerraformIterator ForEach { get; set; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; set; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; set; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; set; }
- Type: object[]
public string Name { get; set; }
- Type: string
Specifies the identifier for the database; must be unique for your account.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database#name Database#name}
public string Comment { get; set; }
- Type: string
Specifies a comment for the database.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database#comment Database#comment}
public double DataRetentionTimeInDays { get; set; }
- Type: double
Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object.
A value of 0 effectively disables Time Travel for the specified database. Default value for this field is set to -1, which is a fallback to use Snowflake default. For more information, see Understanding & Using Time Travel.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database#data_retention_time_in_days Database#data_retention_time_in_days}
public string FromDatabase { get; set; }
- Type: string
Specify a database to create a clone from.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database#from_database Database#from_database}
public string FromReplica { get; set; }
- Type: string
Specify a fully-qualified path to a database to create a replica from.
A fully qualified path follows the format of "<organization_name>"."<account_name>"."<db_name>"
. An example would be: "myorg1"."account1"."db1"
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database#from_replica Database#from_replica}
public System.Collections.Generic.IDictionary<string, string> FromShare { get; set; }
- Type: System.Collections.Generic.IDictionary<string, string>
Specify a provider and a share in this map to create a database from a share.
As of version 0.87.0, the provider field is the account locator.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database#from_share Database#from_share}
public string Id { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/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.
public object IsTransient { get; set; }
- Type: object
Specifies a 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/0.91.0/docs/resources/database#is_transient Database#is_transient}
public DatabaseReplicationConfiguration ReplicationConfiguration { get; set; }
replication_configuration block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database#replication_configuration Database#replication_configuration}
using HashiCorp.Cdktf.Providers.Snowflake;
new DatabaseReplicationConfiguration {
string[] Accounts,
object IgnoreEditionCheck = null
};
Name | Type | Description |
---|---|---|
Accounts |
string[] |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database#accounts Database#accounts}. |
IgnoreEditionCheck |
object |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database#ignore_edition_check Database#ignore_edition_check}. |
public string[] Accounts { get; set; }
- Type: string[]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database#accounts Database#accounts}.
public object IgnoreEditionCheck { get; set; }
- Type: object
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database#ignore_edition_check Database#ignore_edition_check}.
using HashiCorp.Cdktf.Providers.Snowflake;
new DatabaseReplicationConfigurationOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name | Type | Description |
---|---|---|
TerraformResource |
HashiCorp.Cdktf.IInterpolatingParent |
The parent resource. |
TerraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
- Type: HashiCorp.Cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
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. |
ResetIgnoreEditionCheck |
No description. |
private string ComputeFqn()
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable InterpolationForAttribute(string Property)
- Type: string
private object Resolve(IResolveContext Context)
Produce the Token's value at resolution time.
- Type: HashiCorp.Cdktf.IResolveContext
private string ToString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
private void ResetIgnoreEditionCheck()
Name | Type | Description |
---|---|---|
CreationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
Fqn |
string |
No description. |
AccountsInput |
string[] |
No description. |
IgnoreEditionCheckInput |
object |
No description. |
Accounts |
string[] |
No description. |
IgnoreEditionCheck |
object |
No description. |
InternalValue |
DatabaseReplicationConfiguration |
No description. |
public string[] CreationStack { get; }
- 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.
public string Fqn { get; }
- Type: string
public string[] AccountsInput { get; }
- Type: string[]
public object IgnoreEditionCheckInput { get; }
- Type: object
public string[] Accounts { get; }
- Type: string[]
public object IgnoreEditionCheck { get; }
- Type: object
public DatabaseReplicationConfiguration InternalValue { get; }