Databricks v1.70.0, May 9 25

Databricks v1.70.0 published on Friday, May 9, 2025 by Pulumi

databricks.AlertV2

Explore with Pulumi AI

Databricks v1.70.0 published on Friday, May 9, 2025 by Pulumi

Create AlertV2 Resource

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

Constructor syntax

new AlertV2(name: string, args?: AlertV2Args, opts?: CustomResourceOptions);

@overload
def AlertV2(resource_name: str,
            args: Optional[AlertV2Args] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def AlertV2(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            custom_description: Optional[str] = None,
            custom_summary: Optional[str] = None,
            display_name: Optional[str] = None,
            evaluation: Optional[AlertV2EvaluationArgs] = None,
            parent_path: Optional[str] = None,
            query_text: Optional[str] = None,
            schedule: Optional[AlertV2ScheduleArgs] = None,
            warehouse_id: Optional[str] = None)

func NewAlertV2(ctx *Context, name string, args *AlertV2Args, opts ...ResourceOption) (*AlertV2, error)

public AlertV2(string name, AlertV2Args? args = null, CustomResourceOptions? opts = null)

public AlertV2(String name, AlertV2Args args)
public AlertV2(String name, AlertV2Args args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args AlertV2Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args AlertV2Args: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AlertV2Args: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AlertV2Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AlertV2Args: 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 alertV2Resource = new Databricks.AlertV2("alertV2Resource", new()
{
    CustomDescription = "string",
    CustomSummary = "string",
    DisplayName = "string",
    Evaluation = new Databricks.Inputs.AlertV2EvaluationArgs
    {
        ComparisonOperator = "string",
        EmptyResultState = "string",
        LastEvaluatedAt = "string",
        Notification = new Databricks.Inputs.AlertV2EvaluationNotificationArgs
        {
            NotifyOnOk = false,
            RetriggerSeconds = 0,
            Subscriptions = new[]
            {
                new Databricks.Inputs.AlertV2EvaluationNotificationSubscriptionArgs
                {
                    DestinationId = "string",
                    UserEmail = "string",
                },
            },
        },
        Source = new Databricks.Inputs.AlertV2EvaluationSourceArgs
        {
            Aggregation = "string",
            Display = "string",
            Name = "string",
        },
        State = "string",
        Threshold = new Databricks.Inputs.AlertV2EvaluationThresholdArgs
        {
            Column = new Databricks.Inputs.AlertV2EvaluationThresholdColumnArgs
            {
                Aggregation = "string",
                Display = "string",
                Name = "string",
            },
            Value = new Databricks.Inputs.AlertV2EvaluationThresholdValueArgs
            {
                BoolValue = false,
                DoubleValue = 0,
                StringValue = "string",
            },
        },
    },
    ParentPath = "string",
    QueryText = "string",
    Schedule = new Databricks.Inputs.AlertV2ScheduleArgs
    {
        PauseStatus = "string",
        QuartzCronSchedule = "string",
        TimezoneId = "string",
    },
    WarehouseId = "string",
});

example, err := databricks.NewAlertV2(ctx, "alertV2Resource", &databricks.AlertV2Args{
	CustomDescription: pulumi.String("string"),
	CustomSummary:     pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	Evaluation: &databricks.AlertV2EvaluationArgs{
		ComparisonOperator: pulumi.String("string"),
		EmptyResultState:   pulumi.String("string"),
		LastEvaluatedAt:    pulumi.String("string"),
		Notification: &databricks.AlertV2EvaluationNotificationArgs{
			NotifyOnOk:       pulumi.Bool(false),
			RetriggerSeconds: pulumi.Int(0),
			Subscriptions: databricks.AlertV2EvaluationNotificationSubscriptionArray{
				&databricks.AlertV2EvaluationNotificationSubscriptionArgs{
					DestinationId: pulumi.String("string"),
					UserEmail:     pulumi.String("string"),
				},
			},
		},
		Source: &databricks.AlertV2EvaluationSourceArgs{
			Aggregation: pulumi.String("string"),
			Display:     pulumi.String("string"),
			Name:        pulumi.String("string"),
		},
		State: pulumi.String("string"),
		Threshold: &databricks.AlertV2EvaluationThresholdArgs{
			Column: &databricks.AlertV2EvaluationThresholdColumnArgs{
				Aggregation: pulumi.String("string"),
				Display:     pulumi.String("string"),
				Name:        pulumi.String("string"),
			},
			Value: &databricks.AlertV2EvaluationThresholdValueArgs{
				BoolValue:   pulumi.Bool(false),
				DoubleValue: pulumi.Float64(0),
				StringValue: pulumi.String("string"),
			},
		},
	},
	ParentPath: pulumi.String("string"),
	QueryText:  pulumi.String("string"),
	Schedule: &databricks.AlertV2ScheduleArgs{
		PauseStatus:        pulumi.String("string"),
		QuartzCronSchedule: pulumi.String("string"),
		TimezoneId:         pulumi.String("string"),
	},
	WarehouseId: pulumi.String("string"),
})

var alertV2Resource = new AlertV2("alertV2Resource", AlertV2Args.builder()
    .customDescription("string")
    .customSummary("string")
    .displayName("string")
    .evaluation(AlertV2EvaluationArgs.builder()
        .comparisonOperator("string")
        .emptyResultState("string")
        .lastEvaluatedAt("string")
        .notification(AlertV2EvaluationNotificationArgs.builder()
            .notifyOnOk(false)
            .retriggerSeconds(0)
            .subscriptions(AlertV2EvaluationNotificationSubscriptionArgs.builder()
                .destinationId("string")
                .userEmail("string")
                .build())
            .build())
        .source(AlertV2EvaluationSourceArgs.builder()
            .aggregation("string")
            .display("string")
            .name("string")
            .build())
        .state("string")
        .threshold(AlertV2EvaluationThresholdArgs.builder()
            .column(AlertV2EvaluationThresholdColumnArgs.builder()
                .aggregation("string")
                .display("string")
                .name("string")
                .build())
            .value(AlertV2EvaluationThresholdValueArgs.builder()
                .boolValue(false)
                .doubleValue(0.0)
                .stringValue("string")
                .build())
            .build())
        .build())
    .parentPath("string")
    .queryText("string")
    .schedule(AlertV2ScheduleArgs.builder()
        .pauseStatus("string")
        .quartzCronSchedule("string")
        .timezoneId("string")
        .build())
    .warehouseId("string")
    .build());

alert_v2_resource = databricks.AlertV2("alertV2Resource",
    custom_description="string",
    custom_summary="string",
    display_name="string",
    evaluation={
        "comparison_operator": "string",
        "empty_result_state": "string",
        "last_evaluated_at": "string",
        "notification": {
            "notify_on_ok": False,
            "retrigger_seconds": 0,
            "subscriptions": [{
                "destination_id": "string",
                "user_email": "string",
            }],
        },
        "source": {
            "aggregation": "string",
            "display": "string",
            "name": "string",
        },
        "state": "string",
        "threshold": {
            "column": {
                "aggregation": "string",
                "display": "string",
                "name": "string",
            },
            "value": {
                "bool_value": False,
                "double_value": 0,
                "string_value": "string",
            },
        },
    },
    parent_path="string",
    query_text="string",
    schedule={
        "pause_status": "string",
        "quartz_cron_schedule": "string",
        "timezone_id": "string",
    },
    warehouse_id="string")

const alertV2Resource = new databricks.AlertV2("alertV2Resource", {
    customDescription: "string",
    customSummary: "string",
    displayName: "string",
    evaluation: {
        comparisonOperator: "string",
        emptyResultState: "string",
        lastEvaluatedAt: "string",
        notification: {
            notifyOnOk: false,
            retriggerSeconds: 0,
            subscriptions: [{
                destinationId: "string",
                userEmail: "string",
            }],
        },
        source: {
            aggregation: "string",
            display: "string",
            name: "string",
        },
        state: "string",
        threshold: {
            column: {
                aggregation: "string",
                display: "string",
                name: "string",
            },
            value: {
                boolValue: false,
                doubleValue: 0,
                stringValue: "string",
            },
        },
    },
    parentPath: "string",
    queryText: "string",
    schedule: {
        pauseStatus: "string",
        quartzCronSchedule: "string",
        timezoneId: "string",
    },
    warehouseId: "string",
});

type: databricks:AlertV2
properties:
    customDescription: string
    customSummary: string
    displayName: string
    evaluation:
        comparisonOperator: string
        emptyResultState: string
        lastEvaluatedAt: string
        notification:
            notifyOnOk: false
            retriggerSeconds: 0
            subscriptions:
                - destinationId: string
                  userEmail: string
        source:
            aggregation: string
            display: string
            name: string
        state: string
        threshold:
            column:
                aggregation: string
                display: string
                name: string
            value:
                boolValue: false
                doubleValue: 0
                stringValue: string
    parentPath: string
    queryText: string
    schedule:
        pauseStatus: string
        quartzCronSchedule: string
        timezoneId: string
    warehouseId: string

AlertV2 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 AlertV2 resource accepts the following input properties:

CustomDescription string
CustomSummary string
DisplayName string
Evaluation AlertV2Evaluation
ParentPath string
QueryText string
Schedule AlertV2Schedule
WarehouseId string

CustomDescription string
CustomSummary string
DisplayName string
Evaluation AlertV2EvaluationArgs
ParentPath string
QueryText string
Schedule AlertV2ScheduleArgs
WarehouseId string

customDescription String
customSummary String
displayName String
evaluation AlertV2Evaluation
parentPath String
queryText String
schedule AlertV2Schedule
warehouseId String

customDescription string
customSummary string
displayName string
evaluation AlertV2Evaluation
parentPath string
queryText string
schedule AlertV2Schedule
warehouseId string

custom_description str
custom_summary str
display_name str
evaluation AlertV2EvaluationArgs
parent_path str
query_text str
schedule AlertV2ScheduleArgs
warehouse_id str

customDescription String
customSummary String
displayName String
evaluation Property Map
parentPath String
queryText String
schedule Property Map
warehouseId String

Outputs

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

CreateTime string
Id string: The provider-assigned unique ID for this managed resource.
LifecycleState string
OwnerUserName string
RunAsUserName string
UpdateTime string

CreateTime string
Id string: The provider-assigned unique ID for this managed resource.
LifecycleState string
OwnerUserName string
RunAsUserName string
UpdateTime string

createTime String
id String: The provider-assigned unique ID for this managed resource.
lifecycleState String
ownerUserName String
runAsUserName String
updateTime String

createTime string
id string: The provider-assigned unique ID for this managed resource.
lifecycleState string
ownerUserName string
runAsUserName string
updateTime string

create_time str
id str: The provider-assigned unique ID for this managed resource.
lifecycle_state str
owner_user_name str
run_as_user_name str
update_time str

createTime String
id String: The provider-assigned unique ID for this managed resource.
lifecycleState String
ownerUserName String
runAsUserName String
updateTime String

Look up Existing AlertV2 Resource

Get an existing AlertV2 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?: AlertV2State, opts?: CustomResourceOptions): AlertV2

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        custom_description: Optional[str] = None,
        custom_summary: Optional[str] = None,
        display_name: Optional[str] = None,
        evaluation: Optional[AlertV2EvaluationArgs] = None,
        lifecycle_state: Optional[str] = None,
        owner_user_name: Optional[str] = None,
        parent_path: Optional[str] = None,
        query_text: Optional[str] = None,
        run_as_user_name: Optional[str] = None,
        schedule: Optional[AlertV2ScheduleArgs] = None,
        update_time: Optional[str] = None,
        warehouse_id: Optional[str] = None) -> AlertV2

func GetAlertV2(ctx *Context, name string, id IDInput, state *AlertV2State, opts ...ResourceOption) (*AlertV2, error)

public static AlertV2 Get(string name, Input<string> id, AlertV2State? state, CustomResourceOptions? opts = null)

public static AlertV2 get(String name, Output<String> id, AlertV2State state, CustomResourceOptions options)

resources:  _:    type: databricks:AlertV2    get:      id: ${id}

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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:

CreateTime string
CustomDescription string
CustomSummary string
DisplayName string
Evaluation AlertV2Evaluation
LifecycleState string
OwnerUserName string
ParentPath string
QueryText string
RunAsUserName string
Schedule AlertV2Schedule
UpdateTime string
WarehouseId string

CreateTime string
CustomDescription string
CustomSummary string
DisplayName string
Evaluation AlertV2EvaluationArgs
LifecycleState string
OwnerUserName string
ParentPath string
QueryText string
RunAsUserName string
Schedule AlertV2ScheduleArgs
UpdateTime string
WarehouseId string

createTime String
customDescription String
customSummary String
displayName String
evaluation AlertV2Evaluation
lifecycleState String
ownerUserName String
parentPath String
queryText String
runAsUserName String
schedule AlertV2Schedule
updateTime String
warehouseId String

createTime string
customDescription string
customSummary string
displayName string
evaluation AlertV2Evaluation
lifecycleState string
ownerUserName string
parentPath string
queryText string
runAsUserName string
schedule AlertV2Schedule
updateTime string
warehouseId string

create_time str
custom_description str
custom_summary str
display_name str
evaluation AlertV2EvaluationArgs
lifecycle_state str
owner_user_name str
parent_path str
query_text str
run_as_user_name str
schedule AlertV2ScheduleArgs
update_time str
warehouse_id str

createTime String
customDescription String
customSummary String
displayName String
evaluation Property Map
lifecycleState String
ownerUserName String
parentPath String
queryText String
runAsUserName String
schedule Property Map
updateTime String
warehouseId String

Supporting Types

AlertV2Evaluation, AlertV2EvaluationArgs

ComparisonOperator string
EmptyResultState string
LastEvaluatedAt string
Notification AlertV2EvaluationNotification
Source AlertV2EvaluationSource
State string
Threshold AlertV2EvaluationThreshold

ComparisonOperator string
EmptyResultState string
LastEvaluatedAt string
Notification AlertV2EvaluationNotification
Source AlertV2EvaluationSource
State string
Threshold AlertV2EvaluationThreshold

comparisonOperator String
emptyResultState String
lastEvaluatedAt String
notification AlertV2EvaluationNotification
source AlertV2EvaluationSource
state String
threshold AlertV2EvaluationThreshold

comparisonOperator string
emptyResultState string
lastEvaluatedAt string
notification AlertV2EvaluationNotification
source AlertV2EvaluationSource
state string
threshold AlertV2EvaluationThreshold

comparison_operator str
empty_result_state str
last_evaluated_at str
notification AlertV2EvaluationNotification
source AlertV2EvaluationSource
state str
threshold AlertV2EvaluationThreshold

comparisonOperator String
emptyResultState String
lastEvaluatedAt String
notification Property Map
source Property Map
state String
threshold Property Map

AlertV2EvaluationNotification, AlertV2EvaluationNotificationArgs

NotifyOnOk bool
RetriggerSeconds int
Subscriptions List<AlertV2EvaluationNotificationSubscription>

NotifyOnOk bool
RetriggerSeconds int
Subscriptions []AlertV2EvaluationNotificationSubscription

notifyOnOk Boolean
retriggerSeconds Integer
subscriptions List<AlertV2EvaluationNotificationSubscription>

notifyOnOk boolean
retriggerSeconds number
subscriptions AlertV2EvaluationNotificationSubscription[]

notify_on_ok bool
retrigger_seconds int
subscriptions Sequence[AlertV2EvaluationNotificationSubscription]

notifyOnOk Boolean
retriggerSeconds Number
subscriptions List<Property Map>

AlertV2EvaluationNotificationSubscription, AlertV2EvaluationNotificationSubscriptionArgs

DestinationId string
UserEmail string

DestinationId string
UserEmail string

destinationId String
userEmail String

destinationId string
userEmail string

destination_id str
user_email str

destinationId String
userEmail String

AlertV2EvaluationSource, AlertV2EvaluationSourceArgs

Aggregation string
Display string
Name string

Aggregation string
Display string
Name string

aggregation String
display String
name String

aggregation string
display string
name string

aggregation str
display str
name str

aggregation String
display String
name String

AlertV2EvaluationThreshold, AlertV2EvaluationThresholdArgs

Column AlertV2EvaluationThresholdColumn
Value AlertV2EvaluationThresholdValue

Column AlertV2EvaluationThresholdColumn
Value AlertV2EvaluationThresholdValue

column AlertV2EvaluationThresholdColumn
value AlertV2EvaluationThresholdValue

column AlertV2EvaluationThresholdColumn
value AlertV2EvaluationThresholdValue

column AlertV2EvaluationThresholdColumn
value AlertV2EvaluationThresholdValue

column Property Map
value Property Map

AlertV2EvaluationThresholdColumn, AlertV2EvaluationThresholdColumnArgs

Aggregation string
Display string
Name string

Aggregation string
Display string
Name string

aggregation String
display String
name String

aggregation string
display string
name string

aggregation str
display str
name str

aggregation String
display String
name String

AlertV2EvaluationThresholdValue, AlertV2EvaluationThresholdValueArgs

BoolValue bool
DoubleValue double
StringValue string

BoolValue bool
DoubleValue float64
StringValue string

boolValue Boolean
doubleValue Double
stringValue String

boolValue boolean
doubleValue number
stringValue string

bool_value bool
double_value float
string_value str

boolValue Boolean
doubleValue Number
stringValue String

AlertV2Schedule, AlertV2ScheduleArgs

PauseStatus string
QuartzCronSchedule string
TimezoneId string

PauseStatus string
QuartzCronSchedule string
TimezoneId string

pauseStatus String
quartzCronSchedule String
timezoneId String

pauseStatus string
quartzCronSchedule string
timezoneId string

pause_status str
quartz_cron_schedule str
timezone_id str

pauseStatus String
quartzCronSchedule String
timezoneId String

Package Details

Repository: databricks pulumi/pulumi-databricks
License: Apache-2.0
Notes: This Pulumi package is based on the databricks Terraform Provider.

Databricks v1.70.0 published on Friday, May 9, 2025 by Pulumi

pulumi/pulumi-databricks

databricks.AlertV2

On this page

On this page

Create AlertV2 Resource

Constructor syntax

Parameters

Constructor example

AlertV2 Resource Properties

Inputs

Outputs

Look up Existing AlertV2 Resource

Supporting Types

AlertV2Evaluation, AlertV2EvaluationArgs

AlertV2EvaluationNotification, AlertV2EvaluationNotificationArgs

AlertV2EvaluationNotificationSubscription, AlertV2EvaluationNotificationSubscriptionArgs

AlertV2EvaluationSource, AlertV2EvaluationSourceArgs

AlertV2EvaluationThreshold, AlertV2EvaluationThresholdArgs

AlertV2EvaluationThresholdColumn, AlertV2EvaluationThresholdColumnArgs

AlertV2EvaluationThresholdValue, AlertV2EvaluationThresholdValueArgs

AlertV2Schedule, AlertV2ScheduleArgs

Package Details

On this page

On this page