Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. DataRobot
  3. API Docs
  4. NotificationPolicy
DataRobot v0.8.17 published on Tuesday, Mar 25, 2025 by DataRobot, Inc.
datarobot-community/pulumi-datarobot

datarobot.NotificationPolicy

Explore with Pulumi AI

datarobot logo
DataRobot v0.8.17 published on Tuesday, Mar 25, 2025 by DataRobot, Inc.
datarobot-community/pulumi-datarobot

    Notification Policy

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as datarobot from "@datarobot/pulumi-datarobot";

const example = new datarobot.NotificationPolicy("example", {
    channelId: "11111111111111",
    channelScope: "template",
    eventGroup: "model_deployments.all",
    relatedEntityId: datarobot_deployment.example.id,
    relatedEntityType: "deployment",
    eventType: "model_deployments.accuracy_green",
    maximalFrequency: "PT1H",
});
export const datarobotNotificationPolicyId = example.id;

    import pulumi
import pulumi_datarobot as datarobot

example = datarobot.NotificationPolicy("example",
    channel_id="11111111111111",
    channel_scope="template",
    event_group="model_deployments.all",
    related_entity_id=datarobot_deployment["example"]["id"],
    related_entity_type="deployment",
    event_type="model_deployments.accuracy_green",
    maximal_frequency="PT1H")
pulumi.export("datarobotNotificationPolicyId", example.id)

    package main

import (
	"github.com/datarobot-community/pulumi-datarobot/sdk/go/datarobot"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := datarobot.NewNotificationPolicy(ctx, "example", &datarobot.NotificationPolicyArgs{
			ChannelId:         pulumi.String("11111111111111"),
			ChannelScope:      pulumi.String("template"),
			EventGroup:        pulumi.String("model_deployments.all"),
			RelatedEntityId:   pulumi.Any(datarobot_deployment.Example.Id),
			RelatedEntityType: pulumi.String("deployment"),
			EventType:         pulumi.String("model_deployments.accuracy_green"),
			MaximalFrequency:  pulumi.String("PT1H"),
		})
		if err != nil {
			return err
		}
		ctx.Export("datarobotNotificationPolicyId", example.ID())
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datarobot = DataRobotPulumi.Datarobot;

return await Deployment.RunAsync(() => 
{
    var example = new Datarobot.NotificationPolicy("example", new()
    {
        ChannelId = "11111111111111",
        ChannelScope = "template",
        EventGroup = "model_deployments.all",
        RelatedEntityId = datarobot_deployment.Example.Id,
        RelatedEntityType = "deployment",
        EventType = "model_deployments.accuracy_green",
        MaximalFrequency = "PT1H",
    });

    return new Dictionary<string, object?>
    {
        ["datarobotNotificationPolicyId"] = example.Id,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datarobot.NotificationPolicy;
import com.pulumi.datarobot.NotificationPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new NotificationPolicy("example", NotificationPolicyArgs.builder()
            .channelId("11111111111111")
            .channelScope("template")
            .eventGroup("model_deployments.all")
            .relatedEntityId(datarobot_deployment.example().id())
            .relatedEntityType("deployment")
            .eventType("model_deployments.accuracy_green")
            .maximalFrequency("PT1H")
            .build());

        ctx.export("datarobotNotificationPolicyId", example.id());
    }
}

    resources:
  example:
    type: datarobot:NotificationPolicy
    properties:
      channelId: '11111111111111'
      channelScope: template
      eventGroup: model_deployments.all
      relatedEntityId: ${datarobot_deployment.example.id}
      relatedEntityType: deployment
      # Optional
      eventType: model_deployments.accuracy_green
      maximalFrequency: PT1H
outputs:
  datarobotNotificationPolicyId: ${example.id}

    Create NotificationPolicy Resource

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

    Constructor syntax

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

@overload
def NotificationPolicy(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       channel_id: Optional[str] = None,
                       channel_scope: Optional[str] = None,
                       related_entity_id: Optional[str] = None,
                       related_entity_type: Optional[str] = None,
                       active: Optional[bool] = None,
                       event_group: Optional[str] = None,
                       event_type: Optional[str] = None,
                       maximal_frequency: Optional[str] = None,
                       name: Optional[str] = None)
    func NewNotificationPolicy(ctx *Context, name string, args NotificationPolicyArgs, opts ...ResourceOption) (*NotificationPolicy, error)
    public NotificationPolicy(string name, NotificationPolicyArgs args, CustomResourceOptions? opts = null)
    public NotificationPolicy(String name, NotificationPolicyArgs args)
public NotificationPolicy(String name, NotificationPolicyArgs args, CustomResourceOptions options)

    type: datarobot:NotificationPolicy
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 NotificationPolicyArgs
    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 NotificationPolicyArgs
    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 NotificationPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NotificationPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NotificationPolicyArgs
    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 notificationPolicyResource = new Datarobot.NotificationPolicy("notificationPolicyResource", new()
{
    ChannelId = "string",
    ChannelScope = "string",
    RelatedEntityId = "string",
    RelatedEntityType = "string",
    Active = false,
    EventGroup = "string",
    EventType = "string",
    MaximalFrequency = "string",
    Name = "string",
});

    example, err := datarobot.NewNotificationPolicy(ctx, "notificationPolicyResource", &datarobot.NotificationPolicyArgs{
	ChannelId:         pulumi.String("string"),
	ChannelScope:      pulumi.String("string"),
	RelatedEntityId:   pulumi.String("string"),
	RelatedEntityType: pulumi.String("string"),
	Active:            pulumi.Bool(false),
	EventGroup:        pulumi.String("string"),
	EventType:         pulumi.String("string"),
	MaximalFrequency:  pulumi.String("string"),
	Name:              pulumi.String("string"),
})

    var notificationPolicyResource = new NotificationPolicy("notificationPolicyResource", NotificationPolicyArgs.builder()
    .channelId("string")
    .channelScope("string")
    .relatedEntityId("string")
    .relatedEntityType("string")
    .active(false)
    .eventGroup("string")
    .eventType("string")
    .maximalFrequency("string")
    .name("string")
    .build());

    notification_policy_resource = datarobot.NotificationPolicy("notificationPolicyResource",
    channel_id="string",
    channel_scope="string",
    related_entity_id="string",
    related_entity_type="string",
    active=False,
    event_group="string",
    event_type="string",
    maximal_frequency="string",
    name="string")

    const notificationPolicyResource = new datarobot.NotificationPolicy("notificationPolicyResource", {
    channelId: "string",
    channelScope: "string",
    relatedEntityId: "string",
    relatedEntityType: "string",
    active: false,
    eventGroup: "string",
    eventType: "string",
    maximalFrequency: "string",
    name: "string",
});

    type: datarobot:NotificationPolicy
properties:
    active: false
    channelId: string
    channelScope: string
    eventGroup: string
    eventType: string
    maximalFrequency: string
    name: string
    relatedEntityId: string
    relatedEntityType: string

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

    ChannelId string
    The Channel ID of the Notification Policy.
    ChannelScope string
    The Channel scope of the Notification Policy.
    RelatedEntityId string
    The ID of the related entity for the Notification Policy.
    RelatedEntityType string
    The Type of the related entity for the Notification Policy.
    Active bool
    Whether or not the Notification Policy is active.
    EventGroup string
    The group of the events that trigger the Notification.
    EventType string
    The group of the event that triggers the Notification.
    MaximalFrequency string
    The maximal frequency between policy runs in ISO 8601 duration string.
    Name string
    The name of the Notification Policy.
    ChannelId string
    The Channel ID of the Notification Policy.
    ChannelScope string
    The Channel scope of the Notification Policy.
    RelatedEntityId string
    The ID of the related entity for the Notification Policy.
    RelatedEntityType string
    The Type of the related entity for the Notification Policy.
    Active bool
    Whether or not the Notification Policy is active.
    EventGroup string
    The group of the events that trigger the Notification.
    EventType string
    The group of the event that triggers the Notification.
    MaximalFrequency string
    The maximal frequency between policy runs in ISO 8601 duration string.
    Name string
    The name of the Notification Policy.
    channelId String
    The Channel ID of the Notification Policy.
    channelScope String
    The Channel scope of the Notification Policy.
    relatedEntityId String
    The ID of the related entity for the Notification Policy.
    relatedEntityType String
    The Type of the related entity for the Notification Policy.
    active Boolean
    Whether or not the Notification Policy is active.
    eventGroup String
    The group of the events that trigger the Notification.
    eventType String
    The group of the event that triggers the Notification.
    maximalFrequency String
    The maximal frequency between policy runs in ISO 8601 duration string.
    name String
    The name of the Notification Policy.
    channelId string
    The Channel ID of the Notification Policy.
    channelScope string
    The Channel scope of the Notification Policy.
    relatedEntityId string
    The ID of the related entity for the Notification Policy.
    relatedEntityType string
    The Type of the related entity for the Notification Policy.
    active boolean
    Whether or not the Notification Policy is active.
    eventGroup string
    The group of the events that trigger the Notification.
    eventType string
    The group of the event that triggers the Notification.
    maximalFrequency string
    The maximal frequency between policy runs in ISO 8601 duration string.
    name string
    The name of the Notification Policy.
    channel_id str
    The Channel ID of the Notification Policy.
    channel_scope str
    The Channel scope of the Notification Policy.
    related_entity_id str
    The ID of the related entity for the Notification Policy.
    related_entity_type str
    The Type of the related entity for the Notification Policy.
    active bool
    Whether or not the Notification Policy is active.
    event_group str
    The group of the events that trigger the Notification.
    event_type str
    The group of the event that triggers the Notification.
    maximal_frequency str
    The maximal frequency between policy runs in ISO 8601 duration string.
    name str
    The name of the Notification Policy.
    channelId String
    The Channel ID of the Notification Policy.
    channelScope String
    The Channel scope of the Notification Policy.
    relatedEntityId String
    The ID of the related entity for the Notification Policy.
    relatedEntityType String
    The Type of the related entity for the Notification Policy.
    active Boolean
    Whether or not the Notification Policy is active.
    eventGroup String
    The group of the events that trigger the Notification.
    eventType String
    The group of the event that triggers the Notification.
    maximalFrequency String
    The maximal frequency between policy runs in ISO 8601 duration string.
    name String
    The name of the Notification Policy.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing NotificationPolicy Resource

    Get an existing NotificationPolicy 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?: NotificationPolicyState, opts?: CustomResourceOptions): NotificationPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        channel_id: Optional[str] = None,
        channel_scope: Optional[str] = None,
        event_group: Optional[str] = None,
        event_type: Optional[str] = None,
        maximal_frequency: Optional[str] = None,
        name: Optional[str] = None,
        related_entity_id: Optional[str] = None,
        related_entity_type: Optional[str] = None) -> NotificationPolicy
    func GetNotificationPolicy(ctx *Context, name string, id IDInput, state *NotificationPolicyState, opts ...ResourceOption) (*NotificationPolicy, error)
    public static NotificationPolicy Get(string name, Input<string> id, NotificationPolicyState? state, CustomResourceOptions? opts = null)
    public static NotificationPolicy get(String name, Output<String> id, NotificationPolicyState state, CustomResourceOptions options)
    resources:  _:    type: datarobot:NotificationPolicy    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:
    Active bool
    Whether or not the Notification Policy is active.
    ChannelId string
    The Channel ID of the Notification Policy.
    ChannelScope string
    The Channel scope of the Notification Policy.
    EventGroup string
    The group of the events that trigger the Notification.
    EventType string
    The group of the event that triggers the Notification.
    MaximalFrequency string
    The maximal frequency between policy runs in ISO 8601 duration string.
    Name string
    The name of the Notification Policy.
    RelatedEntityId string
    The ID of the related entity for the Notification Policy.
    RelatedEntityType string
    The Type of the related entity for the Notification Policy.
    Active bool
    Whether or not the Notification Policy is active.
    ChannelId string
    The Channel ID of the Notification Policy.
    ChannelScope string
    The Channel scope of the Notification Policy.
    EventGroup string
    The group of the events that trigger the Notification.
    EventType string
    The group of the event that triggers the Notification.
    MaximalFrequency string
    The maximal frequency between policy runs in ISO 8601 duration string.
    Name string
    The name of the Notification Policy.
    RelatedEntityId string
    The ID of the related entity for the Notification Policy.
    RelatedEntityType string
    The Type of the related entity for the Notification Policy.
    active Boolean
    Whether or not the Notification Policy is active.
    channelId String
    The Channel ID of the Notification Policy.
    channelScope String
    The Channel scope of the Notification Policy.
    eventGroup String
    The group of the events that trigger the Notification.
    eventType String
    The group of the event that triggers the Notification.
    maximalFrequency String
    The maximal frequency between policy runs in ISO 8601 duration string.
    name String
    The name of the Notification Policy.
    relatedEntityId String
    The ID of the related entity for the Notification Policy.
    relatedEntityType String
    The Type of the related entity for the Notification Policy.
    active boolean
    Whether or not the Notification Policy is active.
    channelId string
    The Channel ID of the Notification Policy.
    channelScope string
    The Channel scope of the Notification Policy.
    eventGroup string
    The group of the events that trigger the Notification.
    eventType string
    The group of the event that triggers the Notification.
    maximalFrequency string
    The maximal frequency between policy runs in ISO 8601 duration string.
    name string
    The name of the Notification Policy.
    relatedEntityId string
    The ID of the related entity for the Notification Policy.
    relatedEntityType string
    The Type of the related entity for the Notification Policy.
    active bool
    Whether or not the Notification Policy is active.
    channel_id str
    The Channel ID of the Notification Policy.
    channel_scope str
    The Channel scope of the Notification Policy.
    event_group str
    The group of the events that trigger the Notification.
    event_type str
    The group of the event that triggers the Notification.
    maximal_frequency str
    The maximal frequency between policy runs in ISO 8601 duration string.
    name str
    The name of the Notification Policy.
    related_entity_id str
    The ID of the related entity for the Notification Policy.
    related_entity_type str
    The Type of the related entity for the Notification Policy.
    active Boolean
    Whether or not the Notification Policy is active.
    channelId String
    The Channel ID of the Notification Policy.
    channelScope String
    The Channel scope of the Notification Policy.
    eventGroup String
    The group of the events that trigger the Notification.
    eventType String
    The group of the event that triggers the Notification.
    maximalFrequency String
    The maximal frequency between policy runs in ISO 8601 duration string.
    name String
    The name of the Notification Policy.
    relatedEntityId String
    The ID of the related entity for the Notification Policy.
    relatedEntityType String
    The Type of the related entity for the Notification Policy.

    Package Details

    Repository
    datarobot datarobot-community/pulumi-datarobot
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datarobot Terraform Provider.
    datarobot logo
    DataRobot v0.8.17 published on Tuesday, Mar 25, 2025 by DataRobot, Inc.
    datarobot-community/pulumi-datarobot