tableconstraint

package
v6.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 5, 2023 License: MPL-2.0 Imports: 7 Imported by: 0

README

snowflake_table_constraint

Refer to the Terraform Registory for docs: snowflake_table_constraint.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewTableConstraintForeignKeyPropertiesOutputReference_Override 

func NewTableConstraintForeignKeyPropertiesOutputReference_Override(t TableConstraintForeignKeyPropertiesOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewTableConstraintForeignKeyPropertiesReferencesOutputReference_Override 

func NewTableConstraintForeignKeyPropertiesReferencesOutputReference_Override(t TableConstraintForeignKeyPropertiesReferencesOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewTableConstraint_Override 

func NewTableConstraint_Override(t TableConstraint, scope constructs.Construct, id *string, config *TableConstraintConfig)

Create a new {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint snowflake_table_constraint} Resource.

func TableConstraint_IsConstruct 

func TableConstraint_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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func TableConstraint_IsTerraformElement 

func TableConstraint_IsTerraformElement(x interface{}) *bool

Experimental.

func TableConstraint_IsTerraformResource 

func TableConstraint_IsTerraformResource(x interface{}) *bool

Experimental.

func TableConstraint_TfResourceType 

func TableConstraint_TfResourceType() *string

Types

type TableConstraint 

type TableConstraint interface {
	cdktf.TerraformResource
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	Columns() *[]*string
	SetColumns(val *[]*string)
	ColumnsInput() *[]*string
	Comment() *string
	SetComment(val *string)
	CommentInput() *string
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	Deferrable() interface{}
	SetDeferrable(val interface{})
	DeferrableInput() interface{}
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Enable() interface{}
	SetEnable(val interface{})
	EnableInput() interface{}
	Enforced() interface{}
	SetEnforced(val interface{})
	EnforcedInput() interface{}
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	ForeignKeyProperties() TableConstraintForeignKeyPropertiesOutputReference
	ForeignKeyPropertiesInput() *TableConstraintForeignKeyProperties
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	Initially() *string
	SetInitially(val *string)
	InitiallyInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Name() *string
	SetName(val *string)
	NameInput() *string
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	Rely() interface{}
	SetRely(val interface{})
	RelyInput() interface{}
	TableId() *string
	SetTableId(val *string)
	TableIdInput() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Type() *string
	SetType(val *string)
	TypeInput() *string
	Validate() interface{}
	SetValidate(val interface{})
	ValidateInput() interface{}
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	PutForeignKeyProperties(value *TableConstraintForeignKeyProperties)
	ResetComment()
	ResetDeferrable()
	ResetEnable()
	ResetEnforced()
	ResetForeignKeyProperties()
	ResetId()
	ResetInitially()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetRely()
	ResetValidate()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint snowflake_table_constraint}.

func NewTableConstraint 

func NewTableConstraint(scope constructs.Construct, id *string, config *TableConstraintConfig) TableConstraint

Create a new {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint snowflake_table_constraint} Resource.

type TableConstraintConfig 

type TableConstraintConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// Columns to use in constraint key.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#columns TableConstraint#columns}
	Columns *[]*string `field:"required" json:"columns" yaml:"columns"`
	// Name of constraint.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#name TableConstraint#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// Idenfifier for table to create constraint on.
	//
	// Must be of the form Note: format must follow: "<db_name>"."<schema_name>"."<table_name>" or "<db_name>.<schema_name>.<table_name>" or "<db_name>|<schema_name>.<table_name>" (snowflake_table.my_table.id)
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#table_id TableConstraint#table_id}
	TableId *string `field:"required" json:"tableId" yaml:"tableId"`
	// Type of constraint, one of 'UNIQUE', 'PRIMARY KEY', 'FOREIGN KEY', or 'NOT NULL'.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#type TableConstraint#type}
	Type *string `field:"required" json:"type" yaml:"type"`
	// Comment for the table constraint.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#comment TableConstraint#comment}
	Comment *string `field:"optional" json:"comment" yaml:"comment"`
	// Whether the constraint is deferrable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#deferrable TableConstraint#deferrable}
	Deferrable interface{} `field:"optional" json:"deferrable" yaml:"deferrable"`
	// Specifies whether the constraint is enabled or disabled. These properties are provided for compatibility with Oracle.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#enable TableConstraint#enable}
	Enable interface{} `field:"optional" json:"enable" yaml:"enable"`
	// Whether the constraint is enforced.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#enforced TableConstraint#enforced}
	Enforced interface{} `field:"optional" json:"enforced" yaml:"enforced"`
	// foreign_key_properties block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#foreign_key_properties TableConstraint#foreign_key_properties}
	ForeignKeyProperties *TableConstraintForeignKeyProperties `field:"optional" json:"foreignKeyProperties" yaml:"foreignKeyProperties"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#id TableConstraint#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.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// Whether the constraint is initially deferred or immediate.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#initially TableConstraint#initially}
	Initially *string `field:"optional" json:"initially" yaml:"initially"`
	// Specifies whether a constraint in NOVALIDATE mode is taken into account during query rewrite.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#rely TableConstraint#rely}
	Rely interface{} `field:"optional" json:"rely" yaml:"rely"`
	// Specifies whether to validate existing data on the table when a constraint is created.
	//
	// Only used in conjunction with the ENABLE property.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#validate TableConstraint#validate}
	Validate interface{} `field:"optional" json:"validate" yaml:"validate"`
}

type TableConstraintForeignKeyProperties 

type TableConstraintForeignKeyProperties struct {
	// The match type for the foreign key. Not applicable for primary/unique keys.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#match TableConstraint#match}
	Match *string `field:"optional" json:"match" yaml:"match"`
	// Specifies the action performed when the primary/unique key for the foreign key is deleted. Not applicable for primary/unique keys.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#on_delete TableConstraint#on_delete}
	OnDelete *string `field:"optional" json:"onDelete" yaml:"onDelete"`
	// Specifies the action performed when the primary/unique key for the foreign key is updated. Not applicable for primary/unique keys.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#on_update TableConstraint#on_update}
	OnUpdate *string `field:"optional" json:"onUpdate" yaml:"onUpdate"`
	// references block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#references TableConstraint#references}
	References *TableConstraintForeignKeyPropertiesReferences `field:"optional" json:"references" yaml:"references"`
}

type TableConstraintForeignKeyPropertiesOutputReference 

type TableConstraintForeignKeyPropertiesOutputReference interface {
	cdktf.ComplexObject
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// 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.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	InternalValue() *TableConstraintForeignKeyProperties
	SetInternalValue(val *TableConstraintForeignKeyProperties)
	Match() *string
	SetMatch(val *string)
	MatchInput() *string
	OnDelete() *string
	SetOnDelete(val *string)
	OnDeleteInput() *string
	OnUpdate() *string
	SetOnUpdate(val *string)
	OnUpdateInput() *string
	References() TableConstraintForeignKeyPropertiesReferencesOutputReference
	ReferencesInput() *TableConstraintForeignKeyPropertiesReferences
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	PutReferences(value *TableConstraintForeignKeyPropertiesReferences)
	ResetMatch()
	ResetOnDelete()
	ResetOnUpdate()
	ResetReferences()
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewTableConstraintForeignKeyPropertiesOutputReference 

func NewTableConstraintForeignKeyPropertiesOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) TableConstraintForeignKeyPropertiesOutputReference

type TableConstraintForeignKeyPropertiesReferences 

type TableConstraintForeignKeyPropertiesReferences struct {
	// Columns to use in foreign key reference.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#columns TableConstraint#columns}
	Columns *[]*string `field:"required" json:"columns" yaml:"columns"`
	// Name of constraint.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.66.1/docs/resources/table_constraint#table_id TableConstraint#table_id}
	TableId *string `field:"required" json:"tableId" yaml:"tableId"`
}

type TableConstraintForeignKeyPropertiesReferencesOutputReference 

type TableConstraintForeignKeyPropertiesReferencesOutputReference interface {
	cdktf.ComplexObject
	Columns() *[]*string
	SetColumns(val *[]*string)
	ColumnsInput() *[]*string
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// 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.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	InternalValue() *TableConstraintForeignKeyPropertiesReferences
	SetInternalValue(val *TableConstraintForeignKeyPropertiesReferences)
	TableId() *string
	SetTableId(val *string)
	TableIdInput() *string
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewTableConstraintForeignKeyPropertiesReferencesOutputReference 

func NewTableConstraintForeignKeyPropertiesReferencesOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) TableConstraintForeignKeyPropertiesReferencesOutputReference

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.