1. Registry
  2. Packages
  3. Vantage Provider
  4. API Docs
  5. BudgetAlert
Viewing docs for vantage 0.3.19
published on Thursday, Sep 10, 2026 by vantage-sh
Viewing docs for vantage 0.3.19
published on Thursday, Sep 10, 2026 by vantage-sh

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vantage from "@pulumi/vantage";
    
    const demoBudgetAlert = new vantage.BudgetAlert("demo_budget_alert", {
        workspaceToken: "wrkspc_47c3254c790e9351",
        budgetTokens: [demoBudget.token],
        threshold: 90,
        durationInDays: "7",
        periodToTrack: "start_of_the_month",
        recipientEmails: ["finops@example.com"],
    });
    
    import pulumi
    import pulumi_vantage as vantage
    
    demo_budget_alert = vantage.BudgetAlert("demo_budget_alert",
        workspace_token="wrkspc_47c3254c790e9351",
        budget_tokens=[demo_budget["token"]],
        threshold=90,
        duration_in_days="7",
        period_to_track="start_of_the_month",
        recipient_emails=["finops@example.com"])
    
    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.NewBudgetAlert(ctx, "demo_budget_alert", &vantage.BudgetAlertArgs{
    			WorkspaceToken: pulumi.String("wrkspc_47c3254c790e9351"),
    			BudgetTokens: pulumi.StringArray{
    				demoBudget.Token,
    			},
    			Threshold:      pulumi.Float64(90),
    			DurationInDays: pulumi.String("7"),
    			PeriodToTrack:  pulumi.String("start_of_the_month"),
    			RecipientEmails: pulumi.StringArray{
    				pulumi.String("finops@example.com"),
    			},
    		})
    		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 demoBudgetAlert = new Vantage.BudgetAlert("demo_budget_alert", new()
        {
            WorkspaceToken = "wrkspc_47c3254c790e9351",
            BudgetTokens = new[]
            {
                demoBudget.Token,
            },
            Threshold = 90,
            DurationInDays = "7",
            PeriodToTrack = "start_of_the_month",
            RecipientEmails = new[]
            {
                "finops@example.com",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vantage.BudgetAlert;
    import com.pulumi.vantage.BudgetAlertArgs;
    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 demoBudgetAlert = new BudgetAlert("demoBudgetAlert", BudgetAlertArgs.builder()
                .workspaceToken("wrkspc_47c3254c790e9351")
                .budgetTokens(demoBudget.token())
                .threshold(90.0)
                .durationInDays("7")
                .periodToTrack("start_of_the_month")
                .recipientEmails("finops@example.com")
                .build());
    
        }
    }
    
    resources:
      demoBudgetAlert:
        type: vantage:BudgetAlert
        name: demo_budget_alert
        properties:
          workspaceToken: wrkspc_47c3254c790e9351
          budgetTokens:
            - ${demoBudget.token}
          threshold: 90 # Days from the start or end of the month to evaluate. Use "" for the full month.
          durationInDays: '7'
          periodToTrack: start_of_the_month
          recipientEmails:
            - finops@example.com
    
    Example coming soon!
    

    Create BudgetAlert Resource

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

    Constructor syntax

    new BudgetAlert(name: string, args: BudgetAlertArgs, opts?: CustomResourceOptions);
    @overload
    def BudgetAlert(resource_name: str,
                    args: BudgetAlertArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def BudgetAlert(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    budget_tokens: Optional[Sequence[str]] = None,
                    duration_in_days: Optional[str] = None,
                    threshold: Optional[float] = None,
                    period_to_track: Optional[str] = None,
                    recipient_channels: Optional[Sequence[str]] = None,
                    recipient_emails: Optional[Sequence[str]] = None,
                    user_tokens: Optional[Sequence[str]] = None,
                    workspace_token: Optional[str] = None)
    func NewBudgetAlert(ctx *Context, name string, args BudgetAlertArgs, opts ...ResourceOption) (*BudgetAlert, error)
    public BudgetAlert(string name, BudgetAlertArgs args, CustomResourceOptions? opts = null)
    public BudgetAlert(String name, BudgetAlertArgs args)
    public BudgetAlert(String name, BudgetAlertArgs args, CustomResourceOptions options)
    
    type: vantage:BudgetAlert
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "vantage_budget_alert" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args BudgetAlertArgs
    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 BudgetAlertArgs
    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 BudgetAlertArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BudgetAlertArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BudgetAlertArgs
    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 budgetAlertResource = new Vantage.BudgetAlert("budgetAlertResource", new()
    {
        BudgetTokens = new[]
        {
            "string",
        },
        DurationInDays = "string",
        Threshold = 0.0,
        PeriodToTrack = "string",
        RecipientChannels = new[]
        {
            "string",
        },
        RecipientEmails = new[]
        {
            "string",
        },
        UserTokens = new[]
        {
            "string",
        },
        WorkspaceToken = "string",
    });
    
    example, err := vantage.NewBudgetAlert(ctx, "budgetAlertResource", &vantage.BudgetAlertArgs{
    	BudgetTokens: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DurationInDays: pulumi.String("string"),
    	Threshold:      pulumi.Float64(0),
    	PeriodToTrack:  pulumi.String("string"),
    	RecipientChannels: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	RecipientEmails: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	UserTokens: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	WorkspaceToken: pulumi.String("string"),
    })
    
    resource "vantage_budget_alert" "budgetAlertResource" {
      lifecycle {
        create_before_destroy = true
      }
      budget_tokens      = ["string"]
      duration_in_days   = "string"
      threshold          = 0
      period_to_track    = "string"
      recipient_channels = ["string"]
      recipient_emails   = ["string"]
      user_tokens        = ["string"]
      workspace_token    = "string"
    }
    
    var budgetAlertResource = new BudgetAlert("budgetAlertResource", BudgetAlertArgs.builder()
        .budgetTokens("string")
        .durationInDays("string")
        .threshold(0.0)
        .periodToTrack("string")
        .recipientChannels("string")
        .recipientEmails("string")
        .userTokens("string")
        .workspaceToken("string")
        .build());
    
    budget_alert_resource = vantage.BudgetAlert("budgetAlertResource",
        budget_tokens=["string"],
        duration_in_days="string",
        threshold=float(0),
        period_to_track="string",
        recipient_channels=["string"],
        recipient_emails=["string"],
        user_tokens=["string"],
        workspace_token="string")
    
    const budgetAlertResource = new vantage.BudgetAlert("budgetAlertResource", {
        budgetTokens: ["string"],
        durationInDays: "string",
        threshold: 0,
        periodToTrack: "string",
        recipientChannels: ["string"],
        recipientEmails: ["string"],
        userTokens: ["string"],
        workspaceToken: "string",
    });
    
    type: vantage:BudgetAlert
    properties:
        budgetTokens:
            - string
        durationInDays: string
        periodToTrack: string
        recipientChannels:
            - string
        recipientEmails:
            - string
        threshold: 0
        userTokens:
            - string
        workspaceToken: string
    

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

    BudgetTokens List<string>
    The tokens of the Budget that has the alert.
    DurationInDays string
    The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use "" for the full month. This write attribute is a string because the API uses an empty-string sentinel; the vantage.getBudgetAlerts data source returns the API's nullable integer response.
    Threshold double
    The threshold amount that must be met for the alert to fire.
    PeriodToTrack string
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Defaults to startofthemonth if not passed. Possible values: startofthemonth, endofthe_month.
    RecipientChannels List<string>
    The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
    RecipientEmails List<string>
    The complete list of email addresses that receive the alert, including addresses derived from user_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
    UserTokens List<string>
    The tokens of organization users that receive the alert. The API also exposes their addresses in recipientemails; freeform verified-domain addresses appear only in recipientemails. At least one recipient list must resolve to a non-empty value when the alert is created.
    WorkspaceToken string
    The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.
    BudgetTokens []string
    The tokens of the Budget that has the alert.
    DurationInDays string
    The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use "" for the full month. This write attribute is a string because the API uses an empty-string sentinel; the vantage.getBudgetAlerts data source returns the API's nullable integer response.
    Threshold float64
    The threshold amount that must be met for the alert to fire.
    PeriodToTrack string
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Defaults to startofthemonth if not passed. Possible values: startofthemonth, endofthe_month.
    RecipientChannels []string
    The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
    RecipientEmails []string
    The complete list of email addresses that receive the alert, including addresses derived from user_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
    UserTokens []string
    The tokens of organization users that receive the alert. The API also exposes their addresses in recipientemails; freeform verified-domain addresses appear only in recipientemails. At least one recipient list must resolve to a non-empty value when the alert is created.
    WorkspaceToken string
    The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.
    budget_tokens list(string)
    The tokens of the Budget that has the alert.
    duration_in_days string
    The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use "" for the full month. This write attribute is a string because the API uses an empty-string sentinel; the vantage.getBudgetAlerts data source returns the API's nullable integer response.
    threshold number
    The threshold amount that must be met for the alert to fire.
    period_to_track string
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Defaults to startofthemonth if not passed. Possible values: startofthemonth, endofthe_month.
    recipient_channels list(string)
    The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
    recipient_emails list(string)
    The complete list of email addresses that receive the alert, including addresses derived from user_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
    user_tokens list(string)
    The tokens of organization users that receive the alert. The API also exposes their addresses in recipientemails; freeform verified-domain addresses appear only in recipientemails. At least one recipient list must resolve to a non-empty value when the alert is created.
    workspace_token string
    The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.
    budgetTokens List<String>
    The tokens of the Budget that has the alert.
    durationInDays String
    The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use "" for the full month. This write attribute is a string because the API uses an empty-string sentinel; the vantage.getBudgetAlerts data source returns the API's nullable integer response.
    threshold Double
    The threshold amount that must be met for the alert to fire.
    periodToTrack String
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Defaults to startofthemonth if not passed. Possible values: startofthemonth, endofthe_month.
    recipientChannels List<String>
    The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
    recipientEmails List<String>
    The complete list of email addresses that receive the alert, including addresses derived from user_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
    userTokens List<String>
    The tokens of organization users that receive the alert. The API also exposes their addresses in recipientemails; freeform verified-domain addresses appear only in recipientemails. At least one recipient list must resolve to a non-empty value when the alert is created.
    workspaceToken String
    The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.
    budgetTokens string[]
    The tokens of the Budget that has the alert.
    durationInDays string
    The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use "" for the full month. This write attribute is a string because the API uses an empty-string sentinel; the vantage.getBudgetAlerts data source returns the API's nullable integer response.
    threshold number
    The threshold amount that must be met for the alert to fire.
    periodToTrack string
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Defaults to startofthemonth if not passed. Possible values: startofthemonth, endofthe_month.
    recipientChannels string[]
    The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
    recipientEmails string[]
    The complete list of email addresses that receive the alert, including addresses derived from user_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
    userTokens string[]
    The tokens of organization users that receive the alert. The API also exposes their addresses in recipientemails; freeform verified-domain addresses appear only in recipientemails. At least one recipient list must resolve to a non-empty value when the alert is created.
    workspaceToken string
    The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.
    budget_tokens Sequence[str]
    The tokens of the Budget that has the alert.
    duration_in_days str
    The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use "" for the full month. This write attribute is a string because the API uses an empty-string sentinel; the vantage.getBudgetAlerts data source returns the API's nullable integer response.
    threshold float
    The threshold amount that must be met for the alert to fire.
    period_to_track str
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Defaults to startofthemonth if not passed. Possible values: startofthemonth, endofthe_month.
    recipient_channels Sequence[str]
    The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
    recipient_emails Sequence[str]
    The complete list of email addresses that receive the alert, including addresses derived from user_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
    user_tokens Sequence[str]
    The tokens of organization users that receive the alert. The API also exposes their addresses in recipientemails; freeform verified-domain addresses appear only in recipientemails. At least one recipient list must resolve to a non-empty value when the alert is created.
    workspace_token str
    The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.
    budgetTokens List<String>
    The tokens of the Budget that has the alert.
    durationInDays String
    The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use "" for the full month. This write attribute is a string because the API uses an empty-string sentinel; the vantage.getBudgetAlerts data source returns the API's nullable integer response.
    threshold Number
    The threshold amount that must be met for the alert to fire.
    periodToTrack String
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Defaults to startofthemonth if not passed. Possible values: startofthemonth, endofthe_month.
    recipientChannels List<String>
    The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
    recipientEmails List<String>
    The complete list of email addresses that receive the alert, including addresses derived from user_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
    userTokens List<String>
    The tokens of organization users that receive the alert. The API also exposes their addresses in recipientemails; freeform verified-domain addresses appear only in recipientemails. At least one recipient list must resolve to a non-empty value when the alert is created.
    workspaceToken String
    The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.

    Outputs

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

    CreatedAt string
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    Id string
    The provider-assigned unique ID for this managed resource.
    IntegrationProvider string
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    Token string
    The token of the budget alert
    UserToken string
    The token for the User who created this BudgetAlert.
    CreatedAt string
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    Id string
    The provider-assigned unique ID for this managed resource.
    IntegrationProvider string
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    Token string
    The token of the budget alert
    UserToken string
    The token for the User who created this BudgetAlert.
    created_at string
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    id string
    The provider-assigned unique ID for this managed resource.
    integration_provider string
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    token string
    The token of the budget alert
    user_token string
    The token for the User who created this BudgetAlert.
    createdAt String
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    id String
    The provider-assigned unique ID for this managed resource.
    integrationProvider String
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    token String
    The token of the budget alert
    userToken String
    The token for the User who created this BudgetAlert.
    createdAt string
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    id string
    The provider-assigned unique ID for this managed resource.
    integrationProvider string
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    token string
    The token of the budget alert
    userToken string
    The token for the User who created this BudgetAlert.
    created_at str
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    id str
    The provider-assigned unique ID for this managed resource.
    integration_provider str
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    token str
    The token of the budget alert
    user_token str
    The token for the User who created this BudgetAlert.
    createdAt String
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    id String
    The provider-assigned unique ID for this managed resource.
    integrationProvider String
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    token String
    The token of the budget alert
    userToken String
    The token for the User who created this BudgetAlert.

    Look up Existing BudgetAlert Resource

    Get an existing BudgetAlert 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?: BudgetAlertState, opts?: CustomResourceOptions): BudgetAlert
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            budget_tokens: Optional[Sequence[str]] = None,
            created_at: Optional[str] = None,
            duration_in_days: Optional[str] = None,
            integration_provider: Optional[str] = None,
            period_to_track: Optional[str] = None,
            recipient_channels: Optional[Sequence[str]] = None,
            recipient_emails: Optional[Sequence[str]] = None,
            threshold: Optional[float] = None,
            token: Optional[str] = None,
            user_token: Optional[str] = None,
            user_tokens: Optional[Sequence[str]] = None,
            workspace_token: Optional[str] = None) -> BudgetAlert
    func GetBudgetAlert(ctx *Context, name string, id IDInput, state *BudgetAlertState, opts ...ResourceOption) (*BudgetAlert, error)
    public static BudgetAlert Get(string name, Input<string> id, BudgetAlertState? state, CustomResourceOptions? opts = null)
    public static BudgetAlert get(String name, Output<String> id, BudgetAlertState state, CustomResourceOptions options)
    resources:  _:    type: vantage:BudgetAlert    get:      id: ${id}
    import {
      to = vantage_budget_alert.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:
    BudgetTokens List<string>
    The tokens of the Budget that has the alert.
    CreatedAt string
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    DurationInDays string
    The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use "" for the full month. This write attribute is a string because the API uses an empty-string sentinel; the vantage.getBudgetAlerts data source returns the API's nullable integer response.
    IntegrationProvider string
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    PeriodToTrack string
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Defaults to startofthemonth if not passed. Possible values: startofthemonth, endofthe_month.
    RecipientChannels List<string>
    The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
    RecipientEmails List<string>
    The complete list of email addresses that receive the alert, including addresses derived from user_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
    Threshold double
    The threshold amount that must be met for the alert to fire.
    Token string
    The token of the budget alert
    UserToken string
    The token for the User who created this BudgetAlert.
    UserTokens List<string>
    The tokens of organization users that receive the alert. The API also exposes their addresses in recipientemails; freeform verified-domain addresses appear only in recipientemails. At least one recipient list must resolve to a non-empty value when the alert is created.
    WorkspaceToken string
    The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.
    BudgetTokens []string
    The tokens of the Budget that has the alert.
    CreatedAt string
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    DurationInDays string
    The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use "" for the full month. This write attribute is a string because the API uses an empty-string sentinel; the vantage.getBudgetAlerts data source returns the API's nullable integer response.
    IntegrationProvider string
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    PeriodToTrack string
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Defaults to startofthemonth if not passed. Possible values: startofthemonth, endofthe_month.
    RecipientChannels []string
    The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
    RecipientEmails []string
    The complete list of email addresses that receive the alert, including addresses derived from user_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
    Threshold float64
    The threshold amount that must be met for the alert to fire.
    Token string
    The token of the budget alert
    UserToken string
    The token for the User who created this BudgetAlert.
    UserTokens []string
    The tokens of organization users that receive the alert. The API also exposes their addresses in recipientemails; freeform verified-domain addresses appear only in recipientemails. At least one recipient list must resolve to a non-empty value when the alert is created.
    WorkspaceToken string
    The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.
    budget_tokens list(string)
    The tokens of the Budget that has the alert.
    created_at string
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    duration_in_days string
    The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use "" for the full month. This write attribute is a string because the API uses an empty-string sentinel; the vantage.getBudgetAlerts data source returns the API's nullable integer response.
    integration_provider string
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    period_to_track string
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Defaults to startofthemonth if not passed. Possible values: startofthemonth, endofthe_month.
    recipient_channels list(string)
    The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
    recipient_emails list(string)
    The complete list of email addresses that receive the alert, including addresses derived from user_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
    threshold number
    The threshold amount that must be met for the alert to fire.
    token string
    The token of the budget alert
    user_token string
    The token for the User who created this BudgetAlert.
    user_tokens list(string)
    The tokens of organization users that receive the alert. The API also exposes their addresses in recipientemails; freeform verified-domain addresses appear only in recipientemails. At least one recipient list must resolve to a non-empty value when the alert is created.
    workspace_token string
    The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.
    budgetTokens List<String>
    The tokens of the Budget that has the alert.
    createdAt String
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    durationInDays String
    The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use "" for the full month. This write attribute is a string because the API uses an empty-string sentinel; the vantage.getBudgetAlerts data source returns the API's nullable integer response.
    integrationProvider String
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    periodToTrack String
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Defaults to startofthemonth if not passed. Possible values: startofthemonth, endofthe_month.
    recipientChannels List<String>
    The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
    recipientEmails List<String>
    The complete list of email addresses that receive the alert, including addresses derived from user_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
    threshold Double
    The threshold amount that must be met for the alert to fire.
    token String
    The token of the budget alert
    userToken String
    The token for the User who created this BudgetAlert.
    userTokens List<String>
    The tokens of organization users that receive the alert. The API also exposes their addresses in recipientemails; freeform verified-domain addresses appear only in recipientemails. At least one recipient list must resolve to a non-empty value when the alert is created.
    workspaceToken String
    The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.
    budgetTokens string[]
    The tokens of the Budget that has the alert.
    createdAt string
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    durationInDays string
    The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use "" for the full month. This write attribute is a string because the API uses an empty-string sentinel; the vantage.getBudgetAlerts data source returns the API's nullable integer response.
    integrationProvider string
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    periodToTrack string
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Defaults to startofthemonth if not passed. Possible values: startofthemonth, endofthe_month.
    recipientChannels string[]
    The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
    recipientEmails string[]
    The complete list of email addresses that receive the alert, including addresses derived from user_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
    threshold number
    The threshold amount that must be met for the alert to fire.
    token string
    The token of the budget alert
    userToken string
    The token for the User who created this BudgetAlert.
    userTokens string[]
    The tokens of organization users that receive the alert. The API also exposes their addresses in recipientemails; freeform verified-domain addresses appear only in recipientemails. At least one recipient list must resolve to a non-empty value when the alert is created.
    workspaceToken string
    The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.
    budget_tokens Sequence[str]
    The tokens of the Budget that has the alert.
    created_at str
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    duration_in_days str
    The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use "" for the full month. This write attribute is a string because the API uses an empty-string sentinel; the vantage.getBudgetAlerts data source returns the API's nullable integer response.
    integration_provider str
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    period_to_track str
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Defaults to startofthemonth if not passed. Possible values: startofthemonth, endofthe_month.
    recipient_channels Sequence[str]
    The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
    recipient_emails Sequence[str]
    The complete list of email addresses that receive the alert, including addresses derived from user_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
    threshold float
    The threshold amount that must be met for the alert to fire.
    token str
    The token of the budget alert
    user_token str
    The token for the User who created this BudgetAlert.
    user_tokens Sequence[str]
    The tokens of organization users that receive the alert. The API also exposes their addresses in recipientemails; freeform verified-domain addresses appear only in recipientemails. At least one recipient list must resolve to a non-empty value when the alert is created.
    workspace_token str
    The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.
    budgetTokens List<String>
    The tokens of the Budget that has the alert.
    createdAt String
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    durationInDays String
    The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use "" for the full month. This write attribute is a string because the API uses an empty-string sentinel; the vantage.getBudgetAlerts data source returns the API's nullable integer response.
    integrationProvider String
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    periodToTrack String
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Defaults to startofthemonth if not passed. Possible values: startofthemonth, endofthe_month.
    recipientChannels List<String>
    The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
    recipientEmails List<String>
    The complete list of email addresses that receive the alert, including addresses derived from user_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
    threshold Number
    The threshold amount that must be met for the alert to fire.
    token String
    The token of the budget alert
    userToken String
    The token for the User who created this BudgetAlert.
    userTokens List<String>
    The tokens of organization users that receive the alert. The API also exposes their addresses in recipientemails; freeform verified-domain addresses appear only in recipientemails. At least one recipient list must resolve to a non-empty value when the alert is created.
    workspaceToken String
    The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.

    Package Details

    Repository
    vantage vantage-sh/terraform-provider-vantage
    License
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    Viewing docs for vantage 0.3.19
    published on Thursday, Sep 10, 2026 by vantage-sh

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial