Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Vantage Provider
  4. API Docs
  5. DashboardNotification
Viewing docs for vantage 0.4.4
published on Monday, Oct 26, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

vantage.DashboardNotification

vantage
Viewing docs for vantage 0.4.4
published on Monday, Oct 26, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as vantage from "@pulumi/vantage";

const demoNotification = new vantage.DashboardNotification("demo_notification", {
    title: "Weekly Executive Dashboard",
    dashboardToken: demoDashboard.token,
    frequency: "weekly",
    userTokens: ["usr_36b848747e1683bc"],
    workspaceToken: "wrkspc_47c3254c790e9351",
});

    import pulumi
import pulumi_vantage as vantage

demo_notification = vantage.DashboardNotification("demo_notification",
    title="Weekly Executive Dashboard",
    dashboard_token=demo_dashboard["token"],
    frequency="weekly",
    user_tokens=["usr_36b848747e1683bc"],
    workspace_token="wrkspc_47c3254c790e9351")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vantage/vantage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vantage.NewDashboardNotification(ctx, "demo_notification", &vantage.DashboardNotificationArgs{
			Title:          pulumi.String("Weekly Executive Dashboard"),
			DashboardToken: pulumi.Any(demoDashboard.Token),
			Frequency:      pulumi.String("weekly"),
			UserTokens: pulumi.StringArray{
				pulumi.String("usr_36b848747e1683bc"),
			},
			WorkspaceToken: pulumi.String("wrkspc_47c3254c790e9351"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vantage = Pulumi.Vantage;

return await Deployment.RunAsync(() => 
{
    var demoNotification = new Vantage.DashboardNotification("demo_notification", new()
    {
        Title = "Weekly Executive Dashboard",
        DashboardToken = demoDashboard.Token,
        Frequency = "weekly",
        UserTokens = new[]
        {
            "usr_36b848747e1683bc",
        },
        WorkspaceToken = "wrkspc_47c3254c790e9351",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vantage.DashboardNotification;
import com.pulumi.vantage.DashboardNotificationArgs;
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 demoNotification = new DashboardNotification("demoNotification", DashboardNotificationArgs.builder()
            .title("Weekly Executive Dashboard")
            .dashboardToken(demoDashboard.token())
            .frequency("weekly")
            .userTokens("usr_36b848747e1683bc")
            .workspaceToken("wrkspc_47c3254c790e9351")
            .build());

    }
}

    resources:
  demoNotification:
    type: vantage:DashboardNotification
    name: demo_notification
    properties:
      title: Weekly Executive Dashboard
      dashboardToken: ${demoDashboard.token}
      frequency: weekly
      userTokens:
        - usr_36b848747e1683bc
      workspaceToken: wrkspc_47c3254c790e9351

    Example coming soon!

    Create DashboardNotification Resource

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

    Constructor syntax

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

@overload
def DashboardNotification(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          dashboard_token: Optional[str] = None,
                          frequency: Optional[str] = None,
                          title: Optional[str] = None,
                          recipient_emails: Optional[Sequence[str]] = None,
                          user_tokens: Optional[Sequence[str]] = None,
                          workspace_token: Optional[str] = None)
    func NewDashboardNotification(ctx *Context, name string, args DashboardNotificationArgs, opts ...ResourceOption) (*DashboardNotification, error)
    public DashboardNotification(string name, DashboardNotificationArgs args, CustomResourceOptions? opts = null)
    public DashboardNotification(String name, DashboardNotificationArgs args)
public DashboardNotification(String name, DashboardNotificationArgs args, CustomResourceOptions options)

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


    resource "vantage_dashboard_notification" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args DashboardNotificationArgs
    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 DashboardNotificationArgs
    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 DashboardNotificationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DashboardNotificationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DashboardNotificationArgs
    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 dashboardNotificationResource = new Vantage.DashboardNotification("dashboardNotificationResource", new()
{
    DashboardToken = "string",
    Frequency = "string",
    Title = "string",
    RecipientEmails = new[]
    {
        "string",
    },
    UserTokens = new[]
    {
        "string",
    },
    WorkspaceToken = "string",
});

    example, err := vantage.NewDashboardNotification(ctx, "dashboardNotificationResource", &vantage.DashboardNotificationArgs{
	DashboardToken: pulumi.String("string"),
	Frequency:      pulumi.String("string"),
	Title:          pulumi.String("string"),
	RecipientEmails: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserTokens: pulumi.StringArray{
		pulumi.String("string"),
	},
	WorkspaceToken: pulumi.String("string"),
})

    resource "vantage_dashboard_notification" "dashboardNotificationResource" {
  lifecycle {
    create_before_destroy = true
  }
  dashboard_token  = "string"
  frequency        = "string"
  title            = "string"
  recipient_emails = ["string"]
  user_tokens      = ["string"]
  workspace_token  = "string"
}

    var dashboardNotificationResource = new DashboardNotification("dashboardNotificationResource", DashboardNotificationArgs.builder()
    .dashboardToken("string")
    .frequency("string")
    .title("string")
    .recipientEmails("string")
    .userTokens("string")
    .workspaceToken("string")
    .build());

    dashboard_notification_resource = vantage.DashboardNotification("dashboardNotificationResource",
    dashboard_token="string",
    frequency="string",
    title="string",
    recipient_emails=["string"],
    user_tokens=["string"],
    workspace_token="string")

    const dashboardNotificationResource = new vantage.DashboardNotification("dashboardNotificationResource", {
    dashboardToken: "string",
    frequency: "string",
    title: "string",
    recipientEmails: ["string"],
    userTokens: ["string"],
    workspaceToken: "string",
});

    type: vantage:DashboardNotification
properties:
    dashboardToken: string
    frequency: string
    recipientEmails:
        - string
    title: string
    userTokens:
        - string
    workspaceToken: string

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

    DashboardToken string
    The Dashboard token.
    Frequency string
    The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.
    Title string
    The title of the DashboardNotification.
    RecipientEmails List<string>
    Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.
    UserTokens List<string>
    The Users that receive the notification.
    WorkspaceToken string
    The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces. Changing this forces a new resource.
    DashboardToken string
    The Dashboard token.
    Frequency string
    The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.
    Title string
    The title of the DashboardNotification.
    RecipientEmails []string
    Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.
    UserTokens []string
    The Users that receive the notification.
    WorkspaceToken string
    The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces. Changing this forces a new resource.
    dashboard_token string
    The Dashboard token.
    frequency string
    The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.
    title string
    The title of the DashboardNotification.
    recipient_emails list(string)
    Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.
    user_tokens list(string)
    The Users that receive the notification.
    workspace_token string
    The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces. Changing this forces a new resource.
    dashboardToken String
    The Dashboard token.
    frequency String
    The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.
    title String
    The title of the DashboardNotification.
    recipientEmails List<String>
    Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.
    userTokens List<String>
    The Users that receive the notification.
    workspaceToken String
    The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces. Changing this forces a new resource.
    dashboardToken string
    The Dashboard token.
    frequency string
    The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.
    title string
    The title of the DashboardNotification.
    recipientEmails string[]
    Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.
    userTokens string[]
    The Users that receive the notification.
    workspaceToken string
    The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces. Changing this forces a new resource.
    dashboard_token str
    The Dashboard token.
    frequency str
    The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.
    title str
    The title of the DashboardNotification.
    recipient_emails Sequence[str]
    Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.
    user_tokens Sequence[str]
    The Users that receive the notification.
    workspace_token str
    The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces. Changing this forces a new resource.
    dashboardToken String
    The Dashboard token.
    frequency String
    The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.
    title String
    The title of the DashboardNotification.
    recipientEmails List<String>
    Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.
    userTokens List<String>
    The Users that receive the notification.
    workspaceToken String
    The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces. Changing this forces a new resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the DashboardNotification
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the DashboardNotification
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token of the DashboardNotification
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the DashboardNotification
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token of the DashboardNotification
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    The token of the DashboardNotification
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the DashboardNotification

    Look up Existing DashboardNotification Resource

    Get an existing DashboardNotification 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?: DashboardNotificationState, opts?: CustomResourceOptions): DashboardNotification
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dashboard_token: Optional[str] = None,
        frequency: Optional[str] = None,
        recipient_emails: Optional[Sequence[str]] = None,
        title: Optional[str] = None,
        token: Optional[str] = None,
        user_tokens: Optional[Sequence[str]] = None,
        workspace_token: Optional[str] = None) -> DashboardNotification
    func GetDashboardNotification(ctx *Context, name string, id IDInput, state *DashboardNotificationState, opts ...ResourceOption) (*DashboardNotification, error)
    public static DashboardNotification Get(string name, Input<string> id, DashboardNotificationState? state, CustomResourceOptions? opts = null)
    public static DashboardNotification get(String name, Output<String> id, DashboardNotificationState state, CustomResourceOptions options)
    resources:  _:    type: vantage:DashboardNotification    get:      id: ${id}
    import {
  to = vantage_dashboard_notification.example
  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:
    DashboardToken string
    The Dashboard token.
    Frequency string
    The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.
    RecipientEmails List<string>
    Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.
    Title string
    The title of the DashboardNotification.
    Token string
    The token of the DashboardNotification
    UserTokens List<string>
    The Users that receive the notification.
    WorkspaceToken string
    The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces. Changing this forces a new resource.
    DashboardToken string
    The Dashboard token.
    Frequency string
    The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.
    RecipientEmails []string
    Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.
    Title string
    The title of the DashboardNotification.
    Token string
    The token of the DashboardNotification
    UserTokens []string
    The Users that receive the notification.
    WorkspaceToken string
    The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces. Changing this forces a new resource.
    dashboard_token string
    The Dashboard token.
    frequency string
    The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.
    recipient_emails list(string)
    Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.
    title string
    The title of the DashboardNotification.
    token string
    The token of the DashboardNotification
    user_tokens list(string)
    The Users that receive the notification.
    workspace_token string
    The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces. Changing this forces a new resource.
    dashboardToken String
    The Dashboard token.
    frequency String
    The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.
    recipientEmails List<String>
    Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.
    title String
    The title of the DashboardNotification.
    token String
    The token of the DashboardNotification
    userTokens List<String>
    The Users that receive the notification.
    workspaceToken String
    The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces. Changing this forces a new resource.
    dashboardToken string
    The Dashboard token.
    frequency string
    The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.
    recipientEmails string[]
    Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.
    title string
    The title of the DashboardNotification.
    token string
    The token of the DashboardNotification
    userTokens string[]
    The Users that receive the notification.
    workspaceToken string
    The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces. Changing this forces a new resource.
    dashboard_token str
    The Dashboard token.
    frequency str
    The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.
    recipient_emails Sequence[str]
    Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.
    title str
    The title of the DashboardNotification.
    token str
    The token of the DashboardNotification
    user_tokens Sequence[str]
    The Users that receive the notification.
    workspace_token str
    The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces. Changing this forces a new resource.
    dashboardToken String
    The Dashboard token.
    frequency String
    The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.
    recipientEmails List<String>
    Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.
    title String
    The title of the DashboardNotification.
    token String
    The token of the DashboardNotification
    userTokens List<String>
    The Users that receive the notification.
    workspaceToken String
    The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces. Changing this forces a new resource.

    Package Details

    Repository
    vantage vantage-sh/terraform-provider-vantage
    License
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    vantage
    Viewing docs for vantage 0.4.4
    published on Monday, Oct 26, 2026 by vantage-sh
    Schema (JSON)
    vantage-sh/terraform-provider-vantage

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial