Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database snowflake_database}.
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11/database"
database.NewDatabase(scope Construct, id *string, config DatabaseConfig) Database
Name | Type | Description |
---|---|---|
scope |
github.com/aws/constructs-go/constructs/v10.Construct |
The scope in which to define this construct. |
id |
*string |
The scoped construct ID. |
config |
DatabaseConfig |
No description. |
- Type: github.com/aws/constructs-go/constructs/v10.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. |
func ToString() *string
Returns a string representation of this construct.
func AddOverride(path *string, value interface{})
- Type: *string
- Type: interface{}
func OverrideLogicalId(newLogicalId *string)
Overrides the auto-generated logical ID with a specific ID.
- Type: *string
The new logical ID to use for this stack element.
func ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
func ToHclTerraform() interface{}
func ToMetadata() interface{}
func ToTerraform() interface{}
Adds this resource to the terraform JSON output.
func AddMoveTarget(moveTarget *string)
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: *string
The string move target that will correspond to this resource.
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
- Type: *string
func GetBooleanAttribute(terraformAttribute *string) IResolvable
- Type: *string
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
- Type: *string
func GetListAttribute(terraformAttribute *string) *[]*string
- Type: *string
func GetNumberAttribute(terraformAttribute *string) *f64
- Type: *string
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
- Type: *string
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
- Type: *string
func GetStringAttribute(terraformAttribute *string) *string
- Type: *string
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
- Type: *string
func HasResourceMove() interface{}
func ImportFrom(id *string, provider TerraformProvider)
- Type: *string
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
func InterpolationForAttribute(terraformAttribute *string) IResolvable
- Type: *string
func MoveFromId(id *string)
Move the resource corresponding to "id" to this resource.
Note that the resource being moved from must be marked as moved using it's instance function.
- Type: *string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
func MoveTo(moveTarget *string, index interface{})
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: interface{}
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
func MoveToId(id *string)
Moves this resource to the resource corresponding to "id".
- Type: *string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
func PutReplicationConfiguration(value DatabaseReplicationConfiguration)
func ResetComment()
func ResetDataRetentionTimeInDays()
func ResetFromDatabase()
func ResetFromReplica()
func ResetFromShare()
func ResetId()
func ResetIsTransient()
func 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 ". |
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11/database"
database.Database_IsConstruct(x interface{}) *bool
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
- Type: interface{}
Any object.
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11/database"
database.Database_IsTerraformElement(x interface{}) *bool
- Type: interface{}
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11/database"
database.Database_IsTerraformResource(x interface{}) *bool
- Type: interface{}
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11/database"
database.Database_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource
Generates CDKTF code for importing a Database resource upon running "cdktf plan ".
- Type: github.com/aws/constructs-go/constructs/v10.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: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
? Optional instance of the provider where the Database to import is found.
Name | Type | Description |
---|---|---|
Node |
github.com/aws/constructs-go/constructs/v10.Node |
The tree node. |
CdktfStack |
github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack |
No description. |
Fqn |
*string |
No description. |
FriendlyUniqueId |
*string |
No description. |
TerraformMetaArguments |
*map[string]interface{} |
No description. |
TerraformResourceType |
*string |
No description. |
TerraformGeneratorMetadata |
github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata |
No description. |
Connection |
interface{} |
No description. |
Count |
interface{} |
No description. |
DependsOn |
*[]*string |
No description. |
ForEach |
github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator |
No description. |
Lifecycle |
github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle |
No description. |
Provider |
github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider |
No description. |
Provisioners |
*[]interface{} |
No description. |
ReplicationConfiguration |
DatabaseReplicationConfigurationOutputReference |
No description. |
CommentInput |
*string |
No description. |
DataRetentionTimeInDaysInput |
*f64 |
No description. |
FromDatabaseInput |
*string |
No description. |
FromReplicaInput |
*string |
No description. |
FromShareInput |
*map[string]*string |
No description. |
IdInput |
*string |
No description. |
IsTransientInput |
interface{} |
No description. |
NameInput |
*string |
No description. |
ReplicationConfigurationInput |
DatabaseReplicationConfiguration |
No description. |
Comment |
*string |
No description. |
DataRetentionTimeInDays |
*f64 |
No description. |
FromDatabase |
*string |
No description. |
FromReplica |
*string |
No description. |
FromShare |
*map[string]*string |
No description. |
Id |
*string |
No description. |
IsTransient |
interface{} |
No description. |
Name |
*string |
No description. |
func Node() Node
- Type: github.com/aws/constructs-go/constructs/v10.Node
The tree node.
func CdktfStack() TerraformStack
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
func Fqn() *string
- Type: *string
func FriendlyUniqueId() *string
- Type: *string
func TerraformMetaArguments() *map[string]interface{}
- Type: *map[string]interface{}
func TerraformResourceType() *string
- Type: *string
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
func Connection() interface{}
- Type: interface{}
func Count() interface{}
- Type: interface{}
func DependsOn() *[]*string
- Type: *[]*string
func ForEach() ITerraformIterator
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
func Lifecycle() TerraformResourceLifecycle
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
func Provider() TerraformProvider
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
func Provisioners() *[]interface{}
- Type: *[]interface{}
func ReplicationConfiguration() DatabaseReplicationConfigurationOutputReference
func CommentInput() *string
- Type: *string
func DataRetentionTimeInDaysInput() *f64
- Type: *f64
func FromDatabaseInput() *string
- Type: *string
func FromReplicaInput() *string
- Type: *string
func FromShareInput() *map[string]*string
- Type: *map[string]*string
func IdInput() *string
- Type: *string
func IsTransientInput() interface{}
- Type: interface{}
func NameInput() *string
- Type: *string
func ReplicationConfigurationInput() DatabaseReplicationConfiguration
func Comment() *string
- Type: *string
func DataRetentionTimeInDays() *f64
- Type: *f64
func FromDatabase() *string
- Type: *string
func FromReplica() *string
- Type: *string
func FromShare() *map[string]*string
- Type: *map[string]*string
func Id() *string
- Type: *string
func IsTransient() interface{}
- Type: interface{}
func Name() *string
- Type: *string
Name | Type | Description |
---|---|---|
TfResourceType |
*string |
No description. |
func TfResourceType() *string
- Type: *string
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11/database"
&database.DatabaseConfig {
Connection: interface{},
Count: interface{},
DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
Provisioners: *[]interface{},
Name: *string,
Comment: *string,
DataRetentionTimeInDays: *f64,
FromDatabase: *string,
FromReplica: *string,
FromShare: *map[string]*string,
Id: *string,
IsTransient: interface{},
ReplicationConfiguration: github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11.database.DatabaseReplicationConfiguration,
}
Name | Type | Description |
---|---|---|
Connection |
interface{} |
No description. |
Count |
interface{} |
No description. |
DependsOn |
*[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable |
No description. |
ForEach |
github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator |
No description. |
Lifecycle |
github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle |
No description. |
Provider |
github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider |
No description. |
Provisioners |
*[]interface{} |
No description. |
Name |
*string |
Specifies the identifier for the database; must be unique for your account. |
Comment |
*string |
Specifies a comment for the database. |
DataRetentionTimeInDays |
*f64 |
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 |
*map[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 |
interface{} |
Specifies a database as transient. |
ReplicationConfiguration |
DatabaseReplicationConfiguration |
replication_configuration block. |
Connection interface{}
- Type: interface{}
Count interface{}
- Type: interface{}
DependsOn *[]ITerraformDependable
- Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEach ITerraformIterator
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
Lifecycle TerraformResourceLifecycle
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
Provider TerraformProvider
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
Provisioners *[]interface{}
- Type: *[]interface{}
Name *string
- 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}
Comment *string
- 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}
DataRetentionTimeInDays *f64
- Type: *f64
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}
FromDatabase *string
- 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}
FromReplica *string
- 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}
FromShare *map[string]*string
- Type: *map[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}
Id *string
- 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.
IsTransient interface{}
- Type: interface{}
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}
ReplicationConfiguration DatabaseReplicationConfiguration
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}
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11/database"
&database.DatabaseReplicationConfiguration {
Accounts: *[]*string,
IgnoreEditionCheck: interface{},
}
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 |
interface{} |
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}. |
Accounts *[]*string
- Type: *[]*string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/database#accounts Database#accounts}.
IgnoreEditionCheck interface{}
- Type: interface{}
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}.
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v11/database"
database.NewDatabaseReplicationConfigurationOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) DatabaseReplicationConfigurationOutputReference
Name | Type | Description |
---|---|---|
terraformResource |
github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
*string |
The attribute on the parent resource this class is referencing. |
- Type: github.com/hashicorp/terraform-cdk-go/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. |
func ComputeFqn() *string
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
- Type: *string
func GetBooleanAttribute(terraformAttribute *string) IResolvable
- Type: *string
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
- Type: *string
func GetListAttribute(terraformAttribute *string) *[]*string
- Type: *string
func GetNumberAttribute(terraformAttribute *string) *f64
- Type: *string
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
- Type: *string
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
- Type: *string
func GetStringAttribute(terraformAttribute *string) *string
- Type: *string
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
- Type: *string
func InterpolationForAttribute(property *string) IResolvable
- Type: *string
func Resolve(_context IResolveContext) interface{}
Produce the Token's value at resolution time.
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
func ToString() *string
Return a string representation of this resolvable object.
Returns a reversible string representation.
func 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 |
interface{} |
No description. |
Accounts |
*[]*string |
No description. |
IgnoreEditionCheck |
interface{} |
No description. |
InternalValue |
DatabaseReplicationConfiguration |
No description. |
func CreationStack() *[]*string
- Type: *[]*string
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
func Fqn() *string
- Type: *string
func AccountsInput() *[]*string
- Type: *[]*string
func IgnoreEditionCheckInput() interface{}
- Type: interface{}
func Accounts() *[]*string
- Type: *[]*string
func IgnoreEditionCheck() interface{}
- Type: interface{}
func InternalValue() DatabaseReplicationConfiguration