alert

README

snowflake_alert

Refer to the Terraform Registory for docs: snowflake_alert.

Documentation

Index

• func Alert_IsConstruct(x interface{}) *bool
• func Alert_IsTerraformElement(x interface{}) *bool
• func Alert_IsTerraformResource(x interface{}) *bool
• func Alert_TfResourceType() *string
• func NewAlertAlertScheduleCronOutputReference_Override(a AlertAlertScheduleCronOutputReference, ...)
• func NewAlertAlertScheduleOutputReference_Override(a AlertAlertScheduleOutputReference, ...)
• func NewAlert_Override(a Alert, scope constructs.Construct, id *string, config *AlertConfig)
• type Alert
  • func NewAlert(scope constructs.Construct, id *string, config *AlertConfig) Alert
• type AlertAlertSchedule
• type AlertAlertScheduleCron
• type AlertAlertScheduleCronOutputReference
  • func NewAlertAlertScheduleCronOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) AlertAlertScheduleCronOutputReference
• type AlertAlertScheduleOutputReference
  • func NewAlertAlertScheduleOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) AlertAlertScheduleOutputReference
• type AlertConfig

Functions

func Alert_IsConstruct

func Alert_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 Alert_IsTerraformElement

func Alert_IsTerraformElement(x interface{}) *bool

Experimental.

func Alert_IsTerraformResource

func Alert_IsTerraformResource(x interface{}) *bool

Experimental.

func Alert_TfResourceType

func Alert_TfResourceType() *string

func NewAlertAlertScheduleCronOutputReference_Override

func NewAlertAlertScheduleCronOutputReference_Override(a AlertAlertScheduleCronOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewAlertAlertScheduleOutputReference_Override

func NewAlertAlertScheduleOutputReference_Override(a AlertAlertScheduleOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewAlert_Override

func NewAlert_Override(a Alert, scope constructs.Construct, id *string, config *AlertConfig)

Create a new {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert snowflake_alert} Resource.

Types

type Alert

type Alert interface {
	cdktf.TerraformResource
	Action() *string
	SetAction(val *string)
	ActionInput() *string
	AlertSchedule() AlertAlertScheduleOutputReference
	AlertScheduleInput() *AlertAlertSchedule
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	Comment() *string
	SetComment(val *string)
	CommentInput() *string
	Condition() *string
	SetCondition(val *string)
	ConditionInput() *string
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	Database() *string
	SetDatabase(val *string)
	DatabaseInput() *string
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Enabled() interface{}
	SetEnabled(val interface{})
	EnabledInput() interface{}
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	SetId(val *string)
	IdInput() *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{}
	Schema() *string
	SetSchema(val *string)
	SchemaInput() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Warehouse() *string
	SetWarehouse(val *string)
	WarehouseInput() *string
	// 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)
	PutAlertSchedule(value *AlertAlertSchedule)
	ResetAlertSchedule()
	ResetComment()
	ResetEnabled()
	ResetId()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	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.71.0/docs/resources/alert snowflake_alert}.

func NewAlert

func NewAlert(scope constructs.Construct, id *string, config *AlertConfig) Alert

Create a new {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert snowflake_alert} Resource.

type AlertAlertSchedule

type AlertAlertSchedule struct {
	// cron block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert#cron Alert#cron}
	Cron *AlertAlertScheduleCron `field:"optional" json:"cron" yaml:"cron"`
	// Specifies the interval in minutes for the alert schedule.
	//
	// The interval must be greater than 0 and less than 1440 (24 hours).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert#interval Alert#interval}
	Interval *float64 `field:"optional" json:"interval" yaml:"interval"`
}

type AlertAlertScheduleCron

type AlertAlertScheduleCron struct {
	// Specifies the cron expression for the alert.
	//
	// The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert#expression Alert#expression}
	Expression *string `field:"required" json:"expression" yaml:"expression"`
	// Specifies the time zone for alert refresh.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert#time_zone Alert#time_zone}
	TimeZone *string `field:"required" json:"timeZone" yaml:"timeZone"`
}

type AlertAlertScheduleCronOutputReference

type AlertAlertScheduleCronOutputReference 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
	Expression() *string
	SetExpression(val *string)
	ExpressionInput() *string
	// Experimental.
	Fqn() *string
	InternalValue() *AlertAlertScheduleCron
	SetInternalValue(val *AlertAlertScheduleCron)
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	TimeZone() *string
	SetTimeZone(val *string)
	TimeZoneInput() *string
	// 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 NewAlertAlertScheduleCronOutputReference

func NewAlertAlertScheduleCronOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) AlertAlertScheduleCronOutputReference

type AlertAlertScheduleOutputReference

type AlertAlertScheduleOutputReference 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
	Cron() AlertAlertScheduleCronOutputReference
	CronInput() *AlertAlertScheduleCron
	// Experimental.
	Fqn() *string
	InternalValue() *AlertAlertSchedule
	SetInternalValue(val *AlertAlertSchedule)
	Interval() *float64
	SetInterval(val *float64)
	IntervalInput() *float64
	// 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
	PutCron(value *AlertAlertScheduleCron)
	ResetCron()
	ResetInterval()
	// 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 NewAlertAlertScheduleOutputReference

func NewAlertAlertScheduleOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) AlertAlertScheduleOutputReference

type AlertConfig

type AlertConfig 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"`
	// The SQL statement that should be executed if the condition returns one or more rows.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert#action Alert#action}
	Action *string `field:"required" json:"action" yaml:"action"`
	// The SQL statement that represents the condition for the alert. (SELECT, SHOW, CALL).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert#condition Alert#condition}
	Condition *string `field:"required" json:"condition" yaml:"condition"`
	// The database in which to create the alert.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert#database Alert#database}
	Database *string `field:"required" json:"database" yaml:"database"`
	// Specifies the identifier for the alert;
	//
	// must be unique for the database and schema in which the alert is created.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert#name Alert#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// The schema in which to create the alert.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert#schema Alert#schema}
	Schema *string `field:"required" json:"schema" yaml:"schema"`
	// The warehouse the alert will use.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert#warehouse Alert#warehouse}
	Warehouse *string `field:"required" json:"warehouse" yaml:"warehouse"`
	// alert_schedule block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert#alert_schedule Alert#alert_schedule}
	AlertSchedule *AlertAlertSchedule `field:"optional" json:"alertSchedule" yaml:"alertSchedule"`
	// Specifies a comment for the alert.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert#comment Alert#comment}
	Comment *string `field:"optional" json:"comment" yaml:"comment"`
	// Specifies if an alert should be 'started' (enabled) after creation or should remain 'suspended' (default).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert#enabled Alert#enabled}
	Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.71.0/docs/resources/alert#id Alert#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"`
}