Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. Alert
Databricks v1.67.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.Alert

Explore with Pulumi AI

Databricks v1.67.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-databricks

Import

This resource can be imported using alert ID:

bash

$ pulumi import databricks:index/alert:Alert this <alert-id>
Copy

Create Alert Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Alert(name: string, args: AlertArgs, opts?: CustomResourceOptions);
@overload
def Alert(resource_name: str,
          args: AlertArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Alert(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          condition: Optional[AlertConditionArgs] = None,
          display_name: Optional[str] = None,
          query_id: Optional[str] = None,
          custom_body: Optional[str] = None,
          custom_subject: Optional[str] = None,
          notify_on_ok: Optional[bool] = None,
          owner_user_name: Optional[str] = None,
          parent_path: Optional[str] = None,
          seconds_to_retrigger: Optional[int] = None)
func NewAlert(ctx *Context, name string, args AlertArgs, opts ...ResourceOption) (*Alert, error)
public Alert(string name, AlertArgs args, CustomResourceOptions? opts = null)
public Alert(String name, AlertArgs args)
public Alert(String name, AlertArgs args, CustomResourceOptions options)

type: databricks:Alert
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AlertArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AlertArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AlertArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AlertArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AlertArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var alertResource = new Databricks.Alert("alertResource", new()
{
    Condition = new Databricks.Inputs.AlertConditionArgs
    {
        Op = "string",
        Operand = new Databricks.Inputs.AlertConditionOperandArgs
        {
            Column = new Databricks.Inputs.AlertConditionOperandColumnArgs
            {
                Name = "string",
            },
        },
        EmptyResultState = "string",
        Threshold = new Databricks.Inputs.AlertConditionThresholdArgs
        {
            Value = new Databricks.Inputs.AlertConditionThresholdValueArgs
            {
                BoolValue = false,
                DoubleValue = 0,
                StringValue = "string",
            },
        },
    },
    DisplayName = "string",
    QueryId = "string",
    CustomBody = "string",
    CustomSubject = "string",
    NotifyOnOk = false,
    OwnerUserName = "string",
    ParentPath = "string",
    SecondsToRetrigger = 0,
});
Copy
example, err := databricks.NewAlert(ctx, "alertResource", &databricks.AlertArgs{
	Condition: &databricks.AlertConditionArgs{
		Op: pulumi.String("string"),
		Operand: &databricks.AlertConditionOperandArgs{
			Column: &databricks.AlertConditionOperandColumnArgs{
				Name: pulumi.String("string"),
			},
		},
		EmptyResultState: pulumi.String("string"),
		Threshold: &databricks.AlertConditionThresholdArgs{
			Value: &databricks.AlertConditionThresholdValueArgs{
				BoolValue:   pulumi.Bool(false),
				DoubleValue: pulumi.Float64(0),
				StringValue: pulumi.String("string"),
			},
		},
	},
	DisplayName:        pulumi.String("string"),
	QueryId:            pulumi.String("string"),
	CustomBody:         pulumi.String("string"),
	CustomSubject:      pulumi.String("string"),
	NotifyOnOk:         pulumi.Bool(false),
	OwnerUserName:      pulumi.String("string"),
	ParentPath:         pulumi.String("string"),
	SecondsToRetrigger: pulumi.Int(0),
})
Copy
var alertResource = new Alert("alertResource", AlertArgs.builder()
    .condition(AlertConditionArgs.builder()
        .op("string")
        .operand(AlertConditionOperandArgs.builder()
            .column(AlertConditionOperandColumnArgs.builder()
                .name("string")
                .build())
            .build())
        .emptyResultState("string")
        .threshold(AlertConditionThresholdArgs.builder()
            .value(AlertConditionThresholdValueArgs.builder()
                .boolValue(false)
                .doubleValue(0)
                .stringValue("string")
                .build())
            .build())
        .build())
    .displayName("string")
    .queryId("string")
    .customBody("string")
    .customSubject("string")
    .notifyOnOk(false)
    .ownerUserName("string")
    .parentPath("string")
    .secondsToRetrigger(0)
    .build());
Copy
alert_resource = databricks.Alert("alertResource",
    condition={
        "op": "string",
        "operand": {
            "column": {
                "name": "string",
            },
        },
        "empty_result_state": "string",
        "threshold": {
            "value": {
                "bool_value": False,
                "double_value": 0,
                "string_value": "string",
            },
        },
    },
    display_name="string",
    query_id="string",
    custom_body="string",
    custom_subject="string",
    notify_on_ok=False,
    owner_user_name="string",
    parent_path="string",
    seconds_to_retrigger=0)
Copy
const alertResource = new databricks.Alert("alertResource", {
    condition: {
        op: "string",
        operand: {
            column: {
                name: "string",
            },
        },
        emptyResultState: "string",
        threshold: {
            value: {
                boolValue: false,
                doubleValue: 0,
                stringValue: "string",
            },
        },
    },
    displayName: "string",
    queryId: "string",
    customBody: "string",
    customSubject: "string",
    notifyOnOk: false,
    ownerUserName: "string",
    parentPath: "string",
    secondsToRetrigger: 0,
});
Copy
type: databricks:Alert
properties:
    condition:
        emptyResultState: string
        op: string
        operand:
            column:
                name: string
        threshold:
            value:
                boolValue: false
                doubleValue: 0
                stringValue: string
    customBody: string
    customSubject: string
    displayName: string
    notifyOnOk: false
    ownerUserName: string
    parentPath: string
    queryId: string
    secondsToRetrigger: 0
Copy

Alert Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Alert resource accepts the following input properties:

Condition This property is required. AlertCondition
Trigger conditions of the alert. Block consists of the following attributes:
DisplayName This property is required. string
Name of the alert.
QueryId This property is required. string
ID of the query evaluated by the alert.
CustomBody string
Custom body of alert notification, if it exists. See Alerts API reference for custom templating instructions.
CustomSubject string
Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See Alerts API reference for custom templating instructions.
NotifyOnOk bool
Whether to notify alert subscribers when alert returns back to normal.
OwnerUserName string
Alert owner's username.
ParentPath Changes to this property will trigger replacement. string
The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.
SecondsToRetrigger int
Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.
Condition This property is required. AlertConditionArgs
Trigger conditions of the alert. Block consists of the following attributes:
DisplayName This property is required. string
Name of the alert.
QueryId This property is required. string
ID of the query evaluated by the alert.
CustomBody string
Custom body of alert notification, if it exists. See Alerts API reference for custom templating instructions.
CustomSubject string
Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See Alerts API reference for custom templating instructions.
NotifyOnOk bool
Whether to notify alert subscribers when alert returns back to normal.
OwnerUserName string
Alert owner's username.
ParentPath Changes to this property will trigger replacement. string
The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.
SecondsToRetrigger int
Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.
condition This property is required. AlertCondition
Trigger conditions of the alert. Block consists of the following attributes:
displayName This property is required. String
Name of the alert.
queryId This property is required. String
ID of the query evaluated by the alert.
customBody String
Custom body of alert notification, if it exists. See Alerts API reference for custom templating instructions.
customSubject String
Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See Alerts API reference for custom templating instructions.
notifyOnOk Boolean
Whether to notify alert subscribers when alert returns back to normal.
ownerUserName String
Alert owner's username.
parentPath Changes to this property will trigger replacement. String
The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.
secondsToRetrigger Integer
Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.
condition This property is required. AlertCondition
Trigger conditions of the alert. Block consists of the following attributes:
displayName This property is required. string
Name of the alert.
queryId This property is required. string
ID of the query evaluated by the alert.
customBody string
Custom body of alert notification, if it exists. See Alerts API reference for custom templating instructions.
customSubject string
Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See Alerts API reference for custom templating instructions.
notifyOnOk boolean
Whether to notify alert subscribers when alert returns back to normal.
ownerUserName string
Alert owner's username.
parentPath Changes to this property will trigger replacement. string
The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.
secondsToRetrigger number
Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.
condition This property is required. AlertConditionArgs
Trigger conditions of the alert. Block consists of the following attributes:
display_name This property is required. str
Name of the alert.
query_id This property is required. str
ID of the query evaluated by the alert.
custom_body str
Custom body of alert notification, if it exists. See Alerts API reference for custom templating instructions.
custom_subject str
Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See Alerts API reference for custom templating instructions.
notify_on_ok bool
Whether to notify alert subscribers when alert returns back to normal.
owner_user_name str
Alert owner's username.
parent_path Changes to this property will trigger replacement. str
The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.
seconds_to_retrigger int
Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.
condition This property is required. Property Map
Trigger conditions of the alert. Block consists of the following attributes:
displayName This property is required. String
Name of the alert.
queryId This property is required. String
ID of the query evaluated by the alert.
customBody String
Custom body of alert notification, if it exists. See Alerts API reference for custom templating instructions.
customSubject String
Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See Alerts API reference for custom templating instructions.
notifyOnOk Boolean
Whether to notify alert subscribers when alert returns back to normal.
ownerUserName String
Alert owner's username.
parentPath Changes to this property will trigger replacement. String
The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.
secondsToRetrigger Number
Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.

Outputs

All input properties are implicitly available as output properties. Additionally, the Alert resource produces the following output properties:

CreateTime string
The timestamp string indicating when the alert was created.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleState string
The workspace state of the alert. Used for tracking trashed status. (Possible values are ACTIVE or TRASHED).
State string
Current state of the alert's trigger status (UNKNOWN, OK, TRIGGERED). This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.
TriggerTime string
The timestamp string when the alert was last triggered if the alert has been triggered before.
UpdateTime string
The timestamp string indicating when the alert was updated.
CreateTime string
The timestamp string indicating when the alert was created.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleState string
The workspace state of the alert. Used for tracking trashed status. (Possible values are ACTIVE or TRASHED).
State string
Current state of the alert's trigger status (UNKNOWN, OK, TRIGGERED). This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.
TriggerTime string
The timestamp string when the alert was last triggered if the alert has been triggered before.
UpdateTime string
The timestamp string indicating when the alert was updated.
createTime String
The timestamp string indicating when the alert was created.
id String
The provider-assigned unique ID for this managed resource.
lifecycleState String
The workspace state of the alert. Used for tracking trashed status. (Possible values are ACTIVE or TRASHED).
state String
Current state of the alert's trigger status (UNKNOWN, OK, TRIGGERED). This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.
triggerTime String
The timestamp string when the alert was last triggered if the alert has been triggered before.
updateTime String
The timestamp string indicating when the alert was updated.
createTime string
The timestamp string indicating when the alert was created.
id string
The provider-assigned unique ID for this managed resource.
lifecycleState string
The workspace state of the alert. Used for tracking trashed status. (Possible values are ACTIVE or TRASHED).
state string
Current state of the alert's trigger status (UNKNOWN, OK, TRIGGERED). This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.
triggerTime string
The timestamp string when the alert was last triggered if the alert has been triggered before.
updateTime string
The timestamp string indicating when the alert was updated.
create_time str
The timestamp string indicating when the alert was created.
id str
The provider-assigned unique ID for this managed resource.
lifecycle_state str
The workspace state of the alert. Used for tracking trashed status. (Possible values are ACTIVE or TRASHED).
state str
Current state of the alert's trigger status (UNKNOWN, OK, TRIGGERED). This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.
trigger_time str
The timestamp string when the alert was last triggered if the alert has been triggered before.
update_time str
The timestamp string indicating when the alert was updated.
createTime String
The timestamp string indicating when the alert was created.
id String
The provider-assigned unique ID for this managed resource.
lifecycleState String
The workspace state of the alert. Used for tracking trashed status. (Possible values are ACTIVE or TRASHED).
state String
Current state of the alert's trigger status (UNKNOWN, OK, TRIGGERED). This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.
triggerTime String
The timestamp string when the alert was last triggered if the alert has been triggered before.
updateTime String
The timestamp string indicating when the alert was updated.

Look up Existing Alert Resource

Get an existing Alert resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AlertState, opts?: CustomResourceOptions): Alert
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        condition: Optional[AlertConditionArgs] = None,
        create_time: Optional[str] = None,
        custom_body: Optional[str] = None,
        custom_subject: Optional[str] = None,
        display_name: Optional[str] = None,
        lifecycle_state: Optional[str] = None,
        notify_on_ok: Optional[bool] = None,
        owner_user_name: Optional[str] = None,
        parent_path: Optional[str] = None,
        query_id: Optional[str] = None,
        seconds_to_retrigger: Optional[int] = None,
        state: Optional[str] = None,
        trigger_time: Optional[str] = None,
        update_time: Optional[str] = None) -> Alert
func GetAlert(ctx *Context, name string, id IDInput, state *AlertState, opts ...ResourceOption) (*Alert, error)
public static Alert Get(string name, Input<string> id, AlertState? state, CustomResourceOptions? opts = null)
public static Alert get(String name, Output<String> id, AlertState state, CustomResourceOptions options)
resources:  _:    type: databricks:Alert    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Condition AlertCondition
Trigger conditions of the alert. Block consists of the following attributes:
CreateTime string
The timestamp string indicating when the alert was created.
CustomBody string
Custom body of alert notification, if it exists. See Alerts API reference for custom templating instructions.
CustomSubject string
Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See Alerts API reference for custom templating instructions.
DisplayName string
Name of the alert.
LifecycleState string
The workspace state of the alert. Used for tracking trashed status. (Possible values are ACTIVE or TRASHED).
NotifyOnOk bool
Whether to notify alert subscribers when alert returns back to normal.
OwnerUserName string
Alert owner's username.
ParentPath Changes to this property will trigger replacement. string
The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.
QueryId string
ID of the query evaluated by the alert.
SecondsToRetrigger int
Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.
State string
Current state of the alert's trigger status (UNKNOWN, OK, TRIGGERED). This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.
TriggerTime string
The timestamp string when the alert was last triggered if the alert has been triggered before.
UpdateTime string
The timestamp string indicating when the alert was updated.
Condition AlertConditionArgs
Trigger conditions of the alert. Block consists of the following attributes:
CreateTime string
The timestamp string indicating when the alert was created.
CustomBody string
Custom body of alert notification, if it exists. See Alerts API reference for custom templating instructions.
CustomSubject string
Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See Alerts API reference for custom templating instructions.
DisplayName string
Name of the alert.
LifecycleState string
The workspace state of the alert. Used for tracking trashed status. (Possible values are ACTIVE or TRASHED).
NotifyOnOk bool
Whether to notify alert subscribers when alert returns back to normal.
OwnerUserName string
Alert owner's username.
ParentPath Changes to this property will trigger replacement. string
The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.
QueryId string
ID of the query evaluated by the alert.
SecondsToRetrigger int
Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.
State string
Current state of the alert's trigger status (UNKNOWN, OK, TRIGGERED). This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.
TriggerTime string
The timestamp string when the alert was last triggered if the alert has been triggered before.
UpdateTime string
The timestamp string indicating when the alert was updated.
condition AlertCondition
Trigger conditions of the alert. Block consists of the following attributes:
createTime String
The timestamp string indicating when the alert was created.
customBody String
Custom body of alert notification, if it exists. See Alerts API reference for custom templating instructions.
customSubject String
Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See Alerts API reference for custom templating instructions.
displayName String
Name of the alert.
lifecycleState String
The workspace state of the alert. Used for tracking trashed status. (Possible values are ACTIVE or TRASHED).
notifyOnOk Boolean
Whether to notify alert subscribers when alert returns back to normal.
ownerUserName String
Alert owner's username.
parentPath Changes to this property will trigger replacement. String
The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.
queryId String
ID of the query evaluated by the alert.
secondsToRetrigger Integer
Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.
state String
Current state of the alert's trigger status (UNKNOWN, OK, TRIGGERED). This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.
triggerTime String
The timestamp string when the alert was last triggered if the alert has been triggered before.
updateTime String
The timestamp string indicating when the alert was updated.
condition AlertCondition
Trigger conditions of the alert. Block consists of the following attributes:
createTime string
The timestamp string indicating when the alert was created.
customBody string
Custom body of alert notification, if it exists. See Alerts API reference for custom templating instructions.
customSubject string
Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See Alerts API reference for custom templating instructions.
displayName string
Name of the alert.
lifecycleState string
The workspace state of the alert. Used for tracking trashed status. (Possible values are ACTIVE or TRASHED).
notifyOnOk boolean
Whether to notify alert subscribers when alert returns back to normal.
ownerUserName string
Alert owner's username.
parentPath Changes to this property will trigger replacement. string
The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.
queryId string
ID of the query evaluated by the alert.
secondsToRetrigger number
Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.
state string
Current state of the alert's trigger status (UNKNOWN, OK, TRIGGERED). This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.
triggerTime string
The timestamp string when the alert was last triggered if the alert has been triggered before.
updateTime string
The timestamp string indicating when the alert was updated.
condition AlertConditionArgs
Trigger conditions of the alert. Block consists of the following attributes:
create_time str
The timestamp string indicating when the alert was created.
custom_body str
Custom body of alert notification, if it exists. See Alerts API reference for custom templating instructions.
custom_subject str
Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See Alerts API reference for custom templating instructions.
display_name str
Name of the alert.
lifecycle_state str
The workspace state of the alert. Used for tracking trashed status. (Possible values are ACTIVE or TRASHED).
notify_on_ok bool
Whether to notify alert subscribers when alert returns back to normal.
owner_user_name str
Alert owner's username.
parent_path Changes to this property will trigger replacement. str
The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.
query_id str
ID of the query evaluated by the alert.
seconds_to_retrigger int
Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.
state str
Current state of the alert's trigger status (UNKNOWN, OK, TRIGGERED). This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.
trigger_time str
The timestamp string when the alert was last triggered if the alert has been triggered before.
update_time str
The timestamp string indicating when the alert was updated.
condition Property Map
Trigger conditions of the alert. Block consists of the following attributes:
createTime String
The timestamp string indicating when the alert was created.
customBody String
Custom body of alert notification, if it exists. See Alerts API reference for custom templating instructions.
customSubject String
Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See Alerts API reference for custom templating instructions.
displayName String
Name of the alert.
lifecycleState String
The workspace state of the alert. Used for tracking trashed status. (Possible values are ACTIVE or TRASHED).
notifyOnOk Boolean
Whether to notify alert subscribers when alert returns back to normal.
ownerUserName String
Alert owner's username.
parentPath Changes to this property will trigger replacement. String
The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.
queryId String
ID of the query evaluated by the alert.
secondsToRetrigger Number
Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.
state String
Current state of the alert's trigger status (UNKNOWN, OK, TRIGGERED). This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.
triggerTime String
The timestamp string when the alert was last triggered if the alert has been triggered before.
updateTime String
The timestamp string indicating when the alert was updated.

Supporting Types

AlertCondition
, AlertConditionArgs

Op This property is required. string
Operator used for comparison in alert evaluation. (Enum: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, EQUAL, NOT_EQUAL, IS_NULL)
Operand This property is required. AlertConditionOperand
Name of the column from the query result to use for comparison in alert evaluation:
EmptyResultState string
Alert state if the result is empty (UNKNOWN, OK, TRIGGERED)
Threshold AlertConditionThreshold
Threshold value used for comparison in alert evaluation:
Op This property is required. string
Operator used for comparison in alert evaluation. (Enum: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, EQUAL, NOT_EQUAL, IS_NULL)
Operand This property is required. AlertConditionOperand
Name of the column from the query result to use for comparison in alert evaluation:
EmptyResultState string
Alert state if the result is empty (UNKNOWN, OK, TRIGGERED)
Threshold AlertConditionThreshold
Threshold value used for comparison in alert evaluation:
op This property is required. String
Operator used for comparison in alert evaluation. (Enum: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, EQUAL, NOT_EQUAL, IS_NULL)
operand This property is required. AlertConditionOperand
Name of the column from the query result to use for comparison in alert evaluation:
emptyResultState String
Alert state if the result is empty (UNKNOWN, OK, TRIGGERED)
threshold AlertConditionThreshold
Threshold value used for comparison in alert evaluation:
op This property is required. string
Operator used for comparison in alert evaluation. (Enum: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, EQUAL, NOT_EQUAL, IS_NULL)
operand This property is required. AlertConditionOperand
Name of the column from the query result to use for comparison in alert evaluation:
emptyResultState string
Alert state if the result is empty (UNKNOWN, OK, TRIGGERED)
threshold AlertConditionThreshold
Threshold value used for comparison in alert evaluation:
op This property is required. str
Operator used for comparison in alert evaluation. (Enum: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, EQUAL, NOT_EQUAL, IS_NULL)
operand This property is required. AlertConditionOperand
Name of the column from the query result to use for comparison in alert evaluation:
empty_result_state str
Alert state if the result is empty (UNKNOWN, OK, TRIGGERED)
threshold AlertConditionThreshold
Threshold value used for comparison in alert evaluation:
op This property is required. String
Operator used for comparison in alert evaluation. (Enum: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, EQUAL, NOT_EQUAL, IS_NULL)
operand This property is required. Property Map
Name of the column from the query result to use for comparison in alert evaluation:
emptyResultState String
Alert state if the result is empty (UNKNOWN, OK, TRIGGERED)
threshold Property Map
Threshold value used for comparison in alert evaluation:

AlertConditionOperand
, AlertConditionOperandArgs

Column This property is required. AlertConditionOperandColumn
Block describing the column from the query result to use for comparison in alert evaluation:
Column This property is required. AlertConditionOperandColumn
Block describing the column from the query result to use for comparison in alert evaluation:
column This property is required. AlertConditionOperandColumn
Block describing the column from the query result to use for comparison in alert evaluation:
column This property is required. AlertConditionOperandColumn
Block describing the column from the query result to use for comparison in alert evaluation:
column This property is required. AlertConditionOperandColumn
Block describing the column from the query result to use for comparison in alert evaluation:
column This property is required. Property Map
Block describing the column from the query result to use for comparison in alert evaluation:

AlertConditionOperandColumn
, AlertConditionOperandColumnArgs

Name This property is required. string
Name of the column.
Name This property is required. string
Name of the column.
name This property is required. String
Name of the column.
name This property is required. string
Name of the column.
name This property is required. str
Name of the column.
name This property is required. String
Name of the column.

AlertConditionThreshold
, AlertConditionThresholdArgs

Value This property is required. AlertConditionThresholdValue
actual value used in comparison (one of the attributes is required):
Value This property is required. AlertConditionThresholdValue
actual value used in comparison (one of the attributes is required):
value This property is required. AlertConditionThresholdValue
actual value used in comparison (one of the attributes is required):
value This property is required. AlertConditionThresholdValue
actual value used in comparison (one of the attributes is required):
value This property is required. AlertConditionThresholdValue
actual value used in comparison (one of the attributes is required):
value This property is required. Property Map
actual value used in comparison (one of the attributes is required):

AlertConditionThresholdValue
, AlertConditionThresholdValueArgs

BoolValue bool
boolean value (true or false) to compare against boolean results.
DoubleValue double
double value to compare against integer and double results.
StringValue string
string value to compare against string results.
BoolValue bool
boolean value (true or false) to compare against boolean results.
DoubleValue float64
double value to compare against integer and double results.
StringValue string
string value to compare against string results.
boolValue Boolean
boolean value (true or false) to compare against boolean results.
doubleValue Double
double value to compare against integer and double results.
stringValue String
string value to compare against string results.
boolValue boolean
boolean value (true or false) to compare against boolean results.
doubleValue number
double value to compare against integer and double results.
stringValue string
string value to compare against string results.
bool_value bool
boolean value (true or false) to compare against boolean results.
double_value float
double value to compare against integer and double results.
string_value str
string value to compare against string results.
boolValue Boolean
boolean value (true or false) to compare against boolean results.
doubleValue Number
double value to compare against integer and double results.
stringValue String
string value to compare against string results.

Package Details

Repository
databricks pulumi/pulumi-databricks
License
Apache-2.0
Notes
This Pulumi package is based on the databricks Terraform Provider.
Databricks v1.67.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-databricks