Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vantage Provider
  3. API Docs
  4. CostAlert
vantage 0.1.56 published on Monday, Apr 28, 2025 by vantage-sh
vantage-sh/terraform-provider-vantage

vantage.CostAlert

Explore with Pulumi AI

vantage logo
vantage 0.1.56 published on Monday, Apr 28, 2025 by vantage-sh
vantage-sh/terraform-provider-vantage

    Create CostAlert Resource

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

    Constructor syntax

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

@overload
def CostAlert(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              interval: Optional[str] = None,
              threshold: Optional[float] = None,
              title: Optional[str] = None,
              unit_type: Optional[str] = None,
              workspace_token: Optional[str] = None,
              email_recipients: Optional[Sequence[str]] = None,
              report_tokens: Optional[Sequence[str]] = None,
              slack_channels: Optional[Sequence[str]] = None,
              teams_channels: Optional[Sequence[str]] = None)
    func NewCostAlert(ctx *Context, name string, args CostAlertArgs, opts ...ResourceOption) (*CostAlert, error)
    public CostAlert(string name, CostAlertArgs args, CustomResourceOptions? opts = null)
    public CostAlert(String name, CostAlertArgs args)
public CostAlert(String name, CostAlertArgs args, CustomResourceOptions options)

    type: vantage:CostAlert
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 CostAlertArgs
    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 CostAlertArgs
    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 CostAlertArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CostAlertArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CostAlertArgs
    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 costAlertResource = new Vantage.CostAlert("costAlertResource", new()
{
    Interval = "string",
    Threshold = 0,
    Title = "string",
    UnitType = "string",
    WorkspaceToken = "string",
    EmailRecipients = new[]
    {
        "string",
    },
    ReportTokens = new[]
    {
        "string",
    },
    SlackChannels = new[]
    {
        "string",
    },
    TeamsChannels = new[]
    {
        "string",
    },
});

    example, err := vantage.NewCostAlert(ctx, "costAlertResource", &vantage.CostAlertArgs{
	Interval:       pulumi.String("string"),
	Threshold:      pulumi.Float64(0),
	Title:          pulumi.String("string"),
	UnitType:       pulumi.String("string"),
	WorkspaceToken: pulumi.String("string"),
	EmailRecipients: pulumi.StringArray{
		pulumi.String("string"),
	},
	ReportTokens: pulumi.StringArray{
		pulumi.String("string"),
	},
	SlackChannels: pulumi.StringArray{
		pulumi.String("string"),
	},
	TeamsChannels: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var costAlertResource = new CostAlert("costAlertResource", CostAlertArgs.builder()
    .interval("string")
    .threshold(0)
    .title("string")
    .unitType("string")
    .workspaceToken("string")
    .emailRecipients("string")
    .reportTokens("string")
    .slackChannels("string")
    .teamsChannels("string")
    .build());

    cost_alert_resource = vantage.CostAlert("costAlertResource",
    interval="string",
    threshold=0,
    title="string",
    unit_type="string",
    workspace_token="string",
    email_recipients=["string"],
    report_tokens=["string"],
    slack_channels=["string"],
    teams_channels=["string"])

    const costAlertResource = new vantage.CostAlert("costAlertResource", {
    interval: "string",
    threshold: 0,
    title: "string",
    unitType: "string",
    workspaceToken: "string",
    emailRecipients: ["string"],
    reportTokens: ["string"],
    slackChannels: ["string"],
    teamsChannels: ["string"],
});

    type: vantage:CostAlert
properties:
    emailRecipients:
        - string
    interval: string
    reportTokens:
        - string
    slackChannels:
        - string
    teamsChannels:
        - string
    threshold: 0
    title: string
    unitType: string
    workspaceToken: string

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

    Interval string
    The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter'.
    Threshold double
    The threshold value for the Cost Alert.
    Title string
    The title of the Cost Alert.
    UnitType string
    The unit type used to compare costs. Options are 'currency' or 'percentage'.
    WorkspaceToken string
    The token of the Workspace to add the Cost Alert to.
    EmailRecipients List<string>
    The email recipients for the Cost Alert.
    ReportTokens List<string>
    The tokens of the reports to alert on.
    SlackChannels List<string>
    The Slack channels that will receive the alert.
    TeamsChannels List<string>
    The Microsoft Teams channels that will receive the alert.
    Interval string
    The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter'.
    Threshold float64
    The threshold value for the Cost Alert.
    Title string
    The title of the Cost Alert.
    UnitType string
    The unit type used to compare costs. Options are 'currency' or 'percentage'.
    WorkspaceToken string
    The token of the Workspace to add the Cost Alert to.
    EmailRecipients []string
    The email recipients for the Cost Alert.
    ReportTokens []string
    The tokens of the reports to alert on.
    SlackChannels []string
    The Slack channels that will receive the alert.
    TeamsChannels []string
    The Microsoft Teams channels that will receive the alert.
    interval String
    The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter'.
    threshold Double
    The threshold value for the Cost Alert.
    title String
    The title of the Cost Alert.
    unitType String
    The unit type used to compare costs. Options are 'currency' or 'percentage'.
    workspaceToken String
    The token of the Workspace to add the Cost Alert to.
    emailRecipients List<String>
    The email recipients for the Cost Alert.
    reportTokens List<String>
    The tokens of the reports to alert on.
    slackChannels List<String>
    The Slack channels that will receive the alert.
    teamsChannels List<String>
    The Microsoft Teams channels that will receive the alert.
    interval string
    The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter'.
    threshold number
    The threshold value for the Cost Alert.
    title string
    The title of the Cost Alert.
    unitType string
    The unit type used to compare costs. Options are 'currency' or 'percentage'.
    workspaceToken string
    The token of the Workspace to add the Cost Alert to.
    emailRecipients string[]
    The email recipients for the Cost Alert.
    reportTokens string[]
    The tokens of the reports to alert on.
    slackChannels string[]
    The Slack channels that will receive the alert.
    teamsChannels string[]
    The Microsoft Teams channels that will receive the alert.
    interval str
    The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter'.
    threshold float
    The threshold value for the Cost Alert.
    title str
    The title of the Cost Alert.
    unit_type str
    The unit type used to compare costs. Options are 'currency' or 'percentage'.
    workspace_token str
    The token of the Workspace to add the Cost Alert to.
    email_recipients Sequence[str]
    The email recipients for the Cost Alert.
    report_tokens Sequence[str]
    The tokens of the reports to alert on.
    slack_channels Sequence[str]
    The Slack channels that will receive the alert.
    teams_channels Sequence[str]
    The Microsoft Teams channels that will receive the alert.
    interval String
    The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter'.
    threshold Number
    The threshold value for the Cost Alert.
    title String
    The title of the Cost Alert.
    unitType String
    The unit type used to compare costs. Options are 'currency' or 'percentage'.
    workspaceToken String
    The token of the Workspace to add the Cost Alert to.
    emailRecipients List<String>
    The email recipients for the Cost Alert.
    reportTokens List<String>
    The tokens of the reports to alert on.
    slackChannels List<String>
    The Slack channels that will receive the alert.
    teamsChannels List<String>
    The Microsoft Teams channels that will receive the alert.

    Outputs

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

    CreatedAt string
    The date and time, in UTC, for when the alert was created. ISO 8601 Formatted.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the cost alert
    UpdatedAt string
    The date and time, in UTC, for when the alert was last updated. ISO 8601 Formatted.
    CreatedAt string
    The date and time, in UTC, for when the alert was created. ISO 8601 Formatted.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the cost alert
    UpdatedAt string
    The date and time, in UTC, for when the alert was last updated. ISO 8601 Formatted.
    createdAt String
    The date and time, in UTC, for when the alert was created. ISO 8601 Formatted.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the cost alert
    updatedAt String
    The date and time, in UTC, for when the alert was last updated. ISO 8601 Formatted.
    createdAt string
    The date and time, in UTC, for when the alert was created. ISO 8601 Formatted.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token of the cost alert
    updatedAt string
    The date and time, in UTC, for when the alert was last updated. ISO 8601 Formatted.
    created_at str
    The date and time, in UTC, for when the alert was created. ISO 8601 Formatted.
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    The token of the cost alert
    updated_at str
    The date and time, in UTC, for when the alert was last updated. ISO 8601 Formatted.
    createdAt String
    The date and time, in UTC, for when the alert was created. ISO 8601 Formatted.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the cost alert
    updatedAt String
    The date and time, in UTC, for when the alert was last updated. ISO 8601 Formatted.

    Look up Existing CostAlert Resource

    Get an existing CostAlert 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?: CostAlertState, opts?: CustomResourceOptions): CostAlert
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        email_recipients: Optional[Sequence[str]] = None,
        interval: Optional[str] = None,
        report_tokens: Optional[Sequence[str]] = None,
        slack_channels: Optional[Sequence[str]] = None,
        teams_channels: Optional[Sequence[str]] = None,
        threshold: Optional[float] = None,
        title: Optional[str] = None,
        token: Optional[str] = None,
        unit_type: Optional[str] = None,
        updated_at: Optional[str] = None,
        workspace_token: Optional[str] = None) -> CostAlert
    func GetCostAlert(ctx *Context, name string, id IDInput, state *CostAlertState, opts ...ResourceOption) (*CostAlert, error)
    public static CostAlert Get(string name, Input<string> id, CostAlertState? state, CustomResourceOptions? opts = null)
    public static CostAlert get(String name, Output<String> id, CostAlertState state, CustomResourceOptions options)
    resources:  _:    type: vantage:CostAlert    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:
    CreatedAt string
    The date and time, in UTC, for when the alert was created. ISO 8601 Formatted.
    EmailRecipients List<string>
    The email recipients for the Cost Alert.
    Interval string
    The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter'.
    ReportTokens List<string>
    The tokens of the reports to alert on.
    SlackChannels List<string>
    The Slack channels that will receive the alert.
    TeamsChannels List<string>
    The Microsoft Teams channels that will receive the alert.
    Threshold double
    The threshold value for the Cost Alert.
    Title string
    The title of the Cost Alert.
    Token string
    The token of the cost alert
    UnitType string
    The unit type used to compare costs. Options are 'currency' or 'percentage'.
    UpdatedAt string
    The date and time, in UTC, for when the alert was last updated. ISO 8601 Formatted.
    WorkspaceToken string
    The token of the Workspace to add the Cost Alert to.
    CreatedAt string
    The date and time, in UTC, for when the alert was created. ISO 8601 Formatted.
    EmailRecipients []string
    The email recipients for the Cost Alert.
    Interval string
    The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter'.
    ReportTokens []string
    The tokens of the reports to alert on.
    SlackChannels []string
    The Slack channels that will receive the alert.
    TeamsChannels []string
    The Microsoft Teams channels that will receive the alert.
    Threshold float64
    The threshold value for the Cost Alert.
    Title string
    The title of the Cost Alert.
    Token string
    The token of the cost alert
    UnitType string
    The unit type used to compare costs. Options are 'currency' or 'percentage'.
    UpdatedAt string
    The date and time, in UTC, for when the alert was last updated. ISO 8601 Formatted.
    WorkspaceToken string
    The token of the Workspace to add the Cost Alert to.
    createdAt String
    The date and time, in UTC, for when the alert was created. ISO 8601 Formatted.
    emailRecipients List<String>
    The email recipients for the Cost Alert.
    interval String
    The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter'.
    reportTokens List<String>
    The tokens of the reports to alert on.
    slackChannels List<String>
    The Slack channels that will receive the alert.
    teamsChannels List<String>
    The Microsoft Teams channels that will receive the alert.
    threshold Double
    The threshold value for the Cost Alert.
    title String
    The title of the Cost Alert.
    token String
    The token of the cost alert
    unitType String
    The unit type used to compare costs. Options are 'currency' or 'percentage'.
    updatedAt String
    The date and time, in UTC, for when the alert was last updated. ISO 8601 Formatted.
    workspaceToken String
    The token of the Workspace to add the Cost Alert to.
    createdAt string
    The date and time, in UTC, for when the alert was created. ISO 8601 Formatted.
    emailRecipients string[]
    The email recipients for the Cost Alert.
    interval string
    The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter'.
    reportTokens string[]
    The tokens of the reports to alert on.
    slackChannels string[]
    The Slack channels that will receive the alert.
    teamsChannels string[]
    The Microsoft Teams channels that will receive the alert.
    threshold number
    The threshold value for the Cost Alert.
    title string
    The title of the Cost Alert.
    token string
    The token of the cost alert
    unitType string
    The unit type used to compare costs. Options are 'currency' or 'percentage'.
    updatedAt string
    The date and time, in UTC, for when the alert was last updated. ISO 8601 Formatted.
    workspaceToken string
    The token of the Workspace to add the Cost Alert to.
    created_at str
    The date and time, in UTC, for when the alert was created. ISO 8601 Formatted.
    email_recipients Sequence[str]
    The email recipients for the Cost Alert.
    interval str
    The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter'.
    report_tokens Sequence[str]
    The tokens of the reports to alert on.
    slack_channels Sequence[str]
    The Slack channels that will receive the alert.
    teams_channels Sequence[str]
    The Microsoft Teams channels that will receive the alert.
    threshold float
    The threshold value for the Cost Alert.
    title str
    The title of the Cost Alert.
    token str
    The token of the cost alert
    unit_type str
    The unit type used to compare costs. Options are 'currency' or 'percentage'.
    updated_at str
    The date and time, in UTC, for when the alert was last updated. ISO 8601 Formatted.
    workspace_token str
    The token of the Workspace to add the Cost Alert to.
    createdAt String
    The date and time, in UTC, for when the alert was created. ISO 8601 Formatted.
    emailRecipients List<String>
    The email recipients for the Cost Alert.
    interval String
    The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter'.
    reportTokens List<String>
    The tokens of the reports to alert on.
    slackChannels List<String>
    The Slack channels that will receive the alert.
    teamsChannels List<String>
    The Microsoft Teams channels that will receive the alert.
    threshold Number
    The threshold value for the Cost Alert.
    title String
    The title of the Cost Alert.
    token String
    The token of the cost alert
    unitType String
    The unit type used to compare costs. Options are 'currency' or 'percentage'.
    updatedAt String
    The date and time, in UTC, for when the alert was last updated. ISO 8601 Formatted.
    workspaceToken String
    The token of the Workspace to add the Cost Alert to.

    Package Details

    Repository
    vantage vantage-sh/terraform-provider-vantage
    License
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    vantage logo
    vantage 0.1.56 published on Monday, Apr 28, 2025 by vantage-sh
    vantage-sh/terraform-provider-vantage