1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Budget
  5. Rule
Oracle Cloud Infrastructure v1.29.0 published on Thursday, Mar 28, 2024 by Pulumi

oci.Budget.Rule

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.29.0 published on Thursday, Mar 28, 2024 by Pulumi

    This resource provides the Alert Rule resource in Oracle Cloud Infrastructure Budget service.

    Creates a new Alert Rule.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testAlertRule = new oci.budget.Rule("testAlertRule", {
        budgetId: oci_budget_budget.test_budget.id,
        threshold: _var.alert_rule_threshold,
        thresholdType: _var.alert_rule_threshold_type,
        type: _var.alert_rule_type,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        description: _var.alert_rule_description,
        displayName: _var.alert_rule_display_name,
        freeformTags: {
            Department: "Finance",
        },
        message: _var.alert_rule_message,
        recipients: _var.alert_rule_recipients,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_alert_rule = oci.budget.Rule("testAlertRule",
        budget_id=oci_budget_budget["test_budget"]["id"],
        threshold=var["alert_rule_threshold"],
        threshold_type=var["alert_rule_threshold_type"],
        type=var["alert_rule_type"],
        defined_tags={
            "Operations.CostCenter": "42",
        },
        description=var["alert_rule_description"],
        display_name=var["alert_rule_display_name"],
        freeform_tags={
            "Department": "Finance",
        },
        message=var["alert_rule_message"],
        recipients=var["alert_rule_recipients"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Budget"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Budget.NewRule(ctx, "testAlertRule", &Budget.RuleArgs{
    			BudgetId:      pulumi.Any(oci_budget_budget.Test_budget.Id),
    			Threshold:     pulumi.Any(_var.Alert_rule_threshold),
    			ThresholdType: pulumi.Any(_var.Alert_rule_threshold_type),
    			Type:          pulumi.Any(_var.Alert_rule_type),
    			DefinedTags: pulumi.Map{
    				"Operations.CostCenter": pulumi.Any("42"),
    			},
    			Description: pulumi.Any(_var.Alert_rule_description),
    			DisplayName: pulumi.Any(_var.Alert_rule_display_name),
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("Finance"),
    			},
    			Message:    pulumi.Any(_var.Alert_rule_message),
    			Recipients: pulumi.Any(_var.Alert_rule_recipients),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testAlertRule = new Oci.Budget.Rule("testAlertRule", new()
        {
            BudgetId = oci_budget_budget.Test_budget.Id,
            Threshold = @var.Alert_rule_threshold,
            ThresholdType = @var.Alert_rule_threshold_type,
            Type = @var.Alert_rule_type,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            Description = @var.Alert_rule_description,
            DisplayName = @var.Alert_rule_display_name,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
            Message = @var.Alert_rule_message,
            Recipients = @var.Alert_rule_recipients,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Budget.Rule;
    import com.pulumi.oci.Budget.RuleArgs;
    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 testAlertRule = new Rule("testAlertRule", RuleArgs.builder()        
                .budgetId(oci_budget_budget.test_budget().id())
                .threshold(var_.alert_rule_threshold())
                .thresholdType(var_.alert_rule_threshold_type())
                .type(var_.alert_rule_type())
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .description(var_.alert_rule_description())
                .displayName(var_.alert_rule_display_name())
                .freeformTags(Map.of("Department", "Finance"))
                .message(var_.alert_rule_message())
                .recipients(var_.alert_rule_recipients())
                .build());
    
        }
    }
    
    resources:
      testAlertRule:
        type: oci:Budget:Rule
        properties:
          #Required
          budgetId: ${oci_budget_budget.test_budget.id}
          threshold: ${var.alert_rule_threshold}
          thresholdType: ${var.alert_rule_threshold_type}
          type: ${var.alert_rule_type}
          #Optional
          definedTags:
            Operations.CostCenter: '42'
          description: ${var.alert_rule_description}
          displayName: ${var.alert_rule_display_name}
          freeformTags:
            Department: Finance
          message: ${var.alert_rule_message}
          recipients: ${var.alert_rule_recipients}
    

    Create Rule Resource

    new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);
    @overload
    def Rule(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             budget_id: Optional[str] = None,
             defined_tags: Optional[Mapping[str, Any]] = None,
             description: Optional[str] = None,
             display_name: Optional[str] = None,
             freeform_tags: Optional[Mapping[str, Any]] = None,
             message: Optional[str] = None,
             recipients: Optional[str] = None,
             threshold: Optional[float] = None,
             threshold_type: Optional[str] = None,
             type: Optional[str] = None)
    @overload
    def Rule(resource_name: str,
             args: RuleArgs,
             opts: Optional[ResourceOptions] = None)
    func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)
    public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)
    public Rule(String name, RuleArgs args)
    public Rule(String name, RuleArgs args, CustomResourceOptions options)
    
    type: oci:Budget:Rule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args RuleArgs
    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 RuleArgs
    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 RuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Rule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Rule resource accepts the following input properties:

    BudgetId string
    The unique budget OCID.
    Threshold double
    (Updatable) The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.
    ThresholdType string
    (Updatable) The type of threshold.
    Type string

    (Updatable) The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the alert rule.
    DisplayName string
    (Updatable) The name of the alert rule. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Message string
    (Updatable) The message to be sent to the recipients when the alert rule is triggered.
    Recipients string
    (Updatable) The audience that receives the alert when it triggers. An empty string is interpreted as null.
    BudgetId string
    The unique budget OCID.
    Threshold float64
    (Updatable) The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.
    ThresholdType string
    (Updatable) The type of threshold.
    Type string

    (Updatable) The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the alert rule.
    DisplayName string
    (Updatable) The name of the alert rule. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Message string
    (Updatable) The message to be sent to the recipients when the alert rule is triggered.
    Recipients string
    (Updatable) The audience that receives the alert when it triggers. An empty string is interpreted as null.
    budgetId String
    The unique budget OCID.
    threshold Double
    (Updatable) The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.
    thresholdType String
    (Updatable) The type of threshold.
    type String

    (Updatable) The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the alert rule.
    displayName String
    (Updatable) The name of the alert rule. Avoid entering confidential information.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    message String
    (Updatable) The message to be sent to the recipients when the alert rule is triggered.
    recipients String
    (Updatable) The audience that receives the alert when it triggers. An empty string is interpreted as null.
    budgetId string
    The unique budget OCID.
    threshold number
    (Updatable) The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.
    thresholdType string
    (Updatable) The type of threshold.
    type string

    (Updatable) The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The description of the alert rule.
    displayName string
    (Updatable) The name of the alert rule. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    message string
    (Updatable) The message to be sent to the recipients when the alert rule is triggered.
    recipients string
    (Updatable) The audience that receives the alert when it triggers. An empty string is interpreted as null.
    budget_id str
    The unique budget OCID.
    threshold float
    (Updatable) The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.
    threshold_type str
    (Updatable) The type of threshold.
    type str

    (Updatable) The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The description of the alert rule.
    display_name str
    (Updatable) The name of the alert rule. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    message str
    (Updatable) The message to be sent to the recipients when the alert rule is triggered.
    recipients str
    (Updatable) The audience that receives the alert when it triggers. An empty string is interpreted as null.
    budgetId String
    The unique budget OCID.
    threshold Number
    (Updatable) The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.
    thresholdType String
    (Updatable) The type of threshold.
    type String

    (Updatable) The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the alert rule.
    displayName String
    (Updatable) The name of the alert rule. Avoid entering confidential information.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    message String
    (Updatable) The message to be sent to the recipients when the alert rule is triggered.
    recipients String
    (Updatable) The audience that receives the alert when it triggers. An empty string is interpreted as null.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the alert rule.
    TimeCreated string
    The time when the budget was created.
    TimeUpdated string
    The time when the budget was updated.
    Version int
    The version of the alert rule. Starts from 1 and increments by 1.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the alert rule.
    TimeCreated string
    The time when the budget was created.
    TimeUpdated string
    The time when the budget was updated.
    Version int
    The version of the alert rule. Starts from 1 and increments by 1.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the alert rule.
    timeCreated String
    The time when the budget was created.
    timeUpdated String
    The time when the budget was updated.
    version Integer
    The version of the alert rule. Starts from 1 and increments by 1.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current state of the alert rule.
    timeCreated string
    The time when the budget was created.
    timeUpdated string
    The time when the budget was updated.
    version number
    The version of the alert rule. Starts from 1 and increments by 1.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current state of the alert rule.
    time_created str
    The time when the budget was created.
    time_updated str
    The time when the budget was updated.
    version int
    The version of the alert rule. Starts from 1 and increments by 1.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the alert rule.
    timeCreated String
    The time when the budget was created.
    timeUpdated String
    The time when the budget was updated.
    version Number
    The version of the alert rule. Starts from 1 and increments by 1.

    Look up Existing Rule Resource

    Get an existing Rule 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?: RuleState, opts?: CustomResourceOptions): Rule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            budget_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            message: Optional[str] = None,
            recipients: Optional[str] = None,
            state: Optional[str] = None,
            threshold: Optional[float] = None,
            threshold_type: Optional[str] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None,
            type: Optional[str] = None,
            version: Optional[int] = None) -> Rule
    func GetRule(ctx *Context, name string, id IDInput, state *RuleState, opts ...ResourceOption) (*Rule, error)
    public static Rule Get(string name, Input<string> id, RuleState? state, CustomResourceOptions? opts = null)
    public static Rule get(String name, Output<String> id, RuleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    BudgetId string
    The unique budget OCID.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the alert rule.
    DisplayName string
    (Updatable) The name of the alert rule. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Message string
    (Updatable) The message to be sent to the recipients when the alert rule is triggered.
    Recipients string
    (Updatable) The audience that receives the alert when it triggers. An empty string is interpreted as null.
    State string
    The current state of the alert rule.
    Threshold double
    (Updatable) The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.
    ThresholdType string
    (Updatable) The type of threshold.
    TimeCreated string
    The time when the budget was created.
    TimeUpdated string
    The time when the budget was updated.
    Type string

    (Updatable) The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Version int
    The version of the alert rule. Starts from 1 and increments by 1.
    BudgetId string
    The unique budget OCID.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the alert rule.
    DisplayName string
    (Updatable) The name of the alert rule. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Message string
    (Updatable) The message to be sent to the recipients when the alert rule is triggered.
    Recipients string
    (Updatable) The audience that receives the alert when it triggers. An empty string is interpreted as null.
    State string
    The current state of the alert rule.
    Threshold float64
    (Updatable) The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.
    ThresholdType string
    (Updatable) The type of threshold.
    TimeCreated string
    The time when the budget was created.
    TimeUpdated string
    The time when the budget was updated.
    Type string

    (Updatable) The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Version int
    The version of the alert rule. Starts from 1 and increments by 1.
    budgetId String
    The unique budget OCID.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the alert rule.
    displayName String
    (Updatable) The name of the alert rule. Avoid entering confidential information.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    message String
    (Updatable) The message to be sent to the recipients when the alert rule is triggered.
    recipients String
    (Updatable) The audience that receives the alert when it triggers. An empty string is interpreted as null.
    state String
    The current state of the alert rule.
    threshold Double
    (Updatable) The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.
    thresholdType String
    (Updatable) The type of threshold.
    timeCreated String
    The time when the budget was created.
    timeUpdated String
    The time when the budget was updated.
    type String

    (Updatable) The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    version Integer
    The version of the alert rule. Starts from 1 and increments by 1.
    budgetId string
    The unique budget OCID.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The description of the alert rule.
    displayName string
    (Updatable) The name of the alert rule. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    message string
    (Updatable) The message to be sent to the recipients when the alert rule is triggered.
    recipients string
    (Updatable) The audience that receives the alert when it triggers. An empty string is interpreted as null.
    state string
    The current state of the alert rule.
    threshold number
    (Updatable) The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.
    thresholdType string
    (Updatable) The type of threshold.
    timeCreated string
    The time when the budget was created.
    timeUpdated string
    The time when the budget was updated.
    type string

    (Updatable) The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    version number
    The version of the alert rule. Starts from 1 and increments by 1.
    budget_id str
    The unique budget OCID.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The description of the alert rule.
    display_name str
    (Updatable) The name of the alert rule. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    message str
    (Updatable) The message to be sent to the recipients when the alert rule is triggered.
    recipients str
    (Updatable) The audience that receives the alert when it triggers. An empty string is interpreted as null.
    state str
    The current state of the alert rule.
    threshold float
    (Updatable) The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.
    threshold_type str
    (Updatable) The type of threshold.
    time_created str
    The time when the budget was created.
    time_updated str
    The time when the budget was updated.
    type str

    (Updatable) The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    version int
    The version of the alert rule. Starts from 1 and increments by 1.
    budgetId String
    The unique budget OCID.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the alert rule.
    displayName String
    (Updatable) The name of the alert rule. Avoid entering confidential information.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    message String
    (Updatable) The message to be sent to the recipients when the alert rule is triggered.
    recipients String
    (Updatable) The audience that receives the alert when it triggers. An empty string is interpreted as null.
    state String
    The current state of the alert rule.
    threshold Number
    (Updatable) The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.
    thresholdType String
    (Updatable) The type of threshold.
    timeCreated String
    The time when the budget was created.
    timeUpdated String
    The time when the budget was updated.
    type String

    (Updatable) The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    version Number
    The version of the alert rule. Starts from 1 and increments by 1.

    Import

    AlertRules can be imported using the id, e.g.

    $ pulumi import oci:Budget/rule:Rule test_alert_rule "budgets/{budgetId}/alertRules/{alertRuleId}"
    

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.29.0 published on Thursday, Mar 28, 2024 by Pulumi