1. Pulumi Registry
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Budget
  5. Budget
oci logo
Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.Budget.Budget

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

Creates a new budget.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testBudget = new Oci.Budget.Budget("testBudget", new()
    {
        Amount = @var.Budget_amount,
        CompartmentId = @var.Tenancy_ocid,
        ResetPeriod = @var.Budget_reset_period,
        BudgetProcessingPeriodStartOffset = @var.Budget_budget_processing_period_start_offset,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = @var.Budget_description,
        DisplayName = @var.Budget_display_name,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        ProcessingPeriodType = @var.Budget_processing_period_type,
        TargetCompartmentId = oci_identity_compartment.Test_compartment.Id,
        TargetType = @var.Budget_target_type,
        Targets = @var.Budget_targets,
    });

});

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.NewBudget(ctx, "testBudget", &Budget.BudgetArgs{
			Amount:                            pulumi.Any(_var.Budget_amount),
			CompartmentId:                     pulumi.Any(_var.Tenancy_ocid),
			ResetPeriod:                       pulumi.Any(_var.Budget_reset_period),
			BudgetProcessingPeriodStartOffset: pulumi.Any(_var.Budget_budget_processing_period_start_offset),
			DefinedTags: pulumi.AnyMap{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			Description: pulumi.Any(_var.Budget_description),
			DisplayName: pulumi.Any(_var.Budget_display_name),
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
			ProcessingPeriodType: pulumi.Any(_var.Budget_processing_period_type),
			TargetCompartmentId:  pulumi.Any(oci_identity_compartment.Test_compartment.Id),
			TargetType:           pulumi.Any(_var.Budget_target_type),
			Targets:              pulumi.Any(_var.Budget_targets),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Budget.Budget;
import com.pulumi.oci.Budget.BudgetArgs;
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 testBudget = new Budget("testBudget", BudgetArgs.builder()        
            .amount(var_.budget_amount())
            .compartmentId(var_.tenancy_ocid())
            .resetPeriod(var_.budget_reset_period())
            .budgetProcessingPeriodStartOffset(var_.budget_budget_processing_period_start_offset())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(var_.budget_description())
            .displayName(var_.budget_display_name())
            .freeformTags(Map.of("Department", "Finance"))
            .processingPeriodType(var_.budget_processing_period_type())
            .targetCompartmentId(oci_identity_compartment.test_compartment().id())
            .targetType(var_.budget_target_type())
            .targets(var_.budget_targets())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_budget = oci.budget.Budget("testBudget",
    amount=var["budget_amount"],
    compartment_id=var["tenancy_ocid"],
    reset_period=var["budget_reset_period"],
    budget_processing_period_start_offset=var["budget_budget_processing_period_start_offset"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=var["budget_description"],
    display_name=var["budget_display_name"],
    freeform_tags={
        "Department": "Finance",
    },
    processing_period_type=var["budget_processing_period_type"],
    target_compartment_id=oci_identity_compartment["test_compartment"]["id"],
    target_type=var["budget_target_type"],
    targets=var["budget_targets"])

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

const testBudget = new oci.budget.Budget("testBudget", {
    amount: _var.budget_amount,
    compartmentId: _var.tenancy_ocid,
    resetPeriod: _var.budget_reset_period,
    budgetProcessingPeriodStartOffset: _var.budget_budget_processing_period_start_offset,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: _var.budget_description,
    displayName: _var.budget_display_name,
    freeformTags: {
        Department: "Finance",
    },
    processingPeriodType: _var.budget_processing_period_type,
    targetCompartmentId: oci_identity_compartment.test_compartment.id,
    targetType: _var.budget_target_type,
    targets: _var.budget_targets,
});

resources:
  testBudget:
    type: oci:Budget:Budget
    properties:
      #Required
      amount: ${var.budget_amount}
      compartmentId: ${var.tenancy_ocid}
      resetPeriod: ${var.budget_reset_period}
      #Optional
      budgetProcessingPeriodStartOffset: ${var.budget_budget_processing_period_start_offset}
      definedTags:
        Operations.CostCenter: '42'
      description: ${var.budget_description}
      displayName: ${var.budget_display_name}
      freeformTags:
        Department: Finance
      processingPeriodType: ${var.budget_processing_period_type}
      targetCompartmentId: ${oci_identity_compartment.test_compartment.id}
      targetType: ${var.budget_target_type}
      targets: ${var.budget_targets}

Create Budget Resource

new Budget(name: string, args: BudgetArgs, opts?: CustomResourceOptions);
@overload
def Budget(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           amount: Optional[int] = None,
           budget_processing_period_start_offset: Optional[int] = None,
           compartment_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,
           processing_period_type: Optional[str] = None,
           reset_period: Optional[str] = None,
           target_compartment_id: Optional[str] = None,
           target_type: Optional[str] = None,
           targets: Optional[Sequence[str]] = None)
@overload
def Budget(resource_name: str,
           args: BudgetArgs,
           opts: Optional[ResourceOptions] = None)
func NewBudget(ctx *Context, name string, args BudgetArgs, opts ...ResourceOption) (*Budget, error)
public Budget(string name, BudgetArgs args, CustomResourceOptions? opts = null)
public Budget(String name, BudgetArgs args)
public Budget(String name, BudgetArgs args, CustomResourceOptions options)

type: oci:Budget:Budget
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BudgetArgs
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 BudgetArgs
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 BudgetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BudgetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BudgetArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

Amount int

(Updatable) The amount of the budget expressed as a whole number in the currency of the customer's rate card.

CompartmentId string

The OCID of the compartment.

ResetPeriod string

(Updatable) The reset period for the budget. Valid value is MONTHLY.

BudgetProcessingPeriodStartOffset int

(Updatable) The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

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 budget.

DisplayName string

(Updatable) The displayName of the budget. 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"}

ProcessingPeriodType string

(Updatable) The type of the budget processing period. Valid values are INVOICE and MONTH.

TargetCompartmentId string

This is DEPRECATED. Set the target compartment ID in targets instead.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

TargetType string

The type of target on which the budget is applied.

Targets List<string>

The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.

Amount int

(Updatable) The amount of the budget expressed as a whole number in the currency of the customer's rate card.

CompartmentId string

The OCID of the compartment.

ResetPeriod string

(Updatable) The reset period for the budget. Valid value is MONTHLY.

BudgetProcessingPeriodStartOffset int

(Updatable) The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

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 budget.

DisplayName string

(Updatable) The displayName of the budget. 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"}

ProcessingPeriodType string

(Updatable) The type of the budget processing period. Valid values are INVOICE and MONTH.

TargetCompartmentId string

This is DEPRECATED. Set the target compartment ID in targets instead.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

TargetType string

The type of target on which the budget is applied.

Targets []string

The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.

amount Integer

(Updatable) The amount of the budget expressed as a whole number in the currency of the customer's rate card.

compartmentId String

The OCID of the compartment.

resetPeriod String

(Updatable) The reset period for the budget. Valid value is MONTHLY.

budgetProcessingPeriodStartOffset Integer

(Updatable) The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

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 budget.

displayName String

(Updatable) The displayName of the budget. 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"}

processingPeriodType String

(Updatable) The type of the budget processing period. Valid values are INVOICE and MONTH.

targetCompartmentId String

This is DEPRECATED. Set the target compartment ID in targets instead.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

targetType String

The type of target on which the budget is applied.

targets List<String>

The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.

amount number

(Updatable) The amount of the budget expressed as a whole number in the currency of the customer's rate card.

compartmentId string

The OCID of the compartment.

resetPeriod string

(Updatable) The reset period for the budget. Valid value is MONTHLY.

budgetProcessingPeriodStartOffset number

(Updatable) The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

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 budget.

displayName string

(Updatable) The displayName of the budget. 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"}

processingPeriodType string

(Updatable) The type of the budget processing period. Valid values are INVOICE and MONTH.

targetCompartmentId string

This is DEPRECATED. Set the target compartment ID in targets instead.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

targetType string

The type of target on which the budget is applied.

targets string[]

The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.

amount int

(Updatable) The amount of the budget expressed as a whole number in the currency of the customer's rate card.

compartment_id str

The OCID of the compartment.

reset_period str

(Updatable) The reset period for the budget. Valid value is MONTHLY.

budget_processing_period_start_offset int

(Updatable) The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

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 budget.

display_name str

(Updatable) The displayName of the budget. 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"}

processing_period_type str

(Updatable) The type of the budget processing period. Valid values are INVOICE and MONTH.

target_compartment_id str

This is DEPRECATED. Set the target compartment ID in targets instead.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

target_type str

The type of target on which the budget is applied.

targets Sequence[str]

The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.

amount Number

(Updatable) The amount of the budget expressed as a whole number in the currency of the customer's rate card.

compartmentId String

The OCID of the compartment.

resetPeriod String

(Updatable) The reset period for the budget. Valid value is MONTHLY.

budgetProcessingPeriodStartOffset Number

(Updatable) The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

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 budget.

displayName String

(Updatable) The displayName of the budget. 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"}

processingPeriodType String

(Updatable) The type of the budget processing period. Valid values are INVOICE and MONTH.

targetCompartmentId String

This is DEPRECATED. Set the target compartment ID in targets instead.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

targetType String

The type of target on which the budget is applied.

targets List<String>

The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.

Outputs

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

ActualSpend double

The actual spend in currency for the current budget cycle.

AlertRuleCount int

The total number of alert rules in the budget.

ForecastedSpend double

The forecasted spend in currency by the end of the current budget cycle.

Id string

The provider-assigned unique ID for this managed resource.

State string

The current state of the budget.

TimeCreated string

The time that the budget was created.

TimeSpendComputed string

The time that the budget spend was last computed.

TimeUpdated string

The time that the budget was updated.

Version int

The version of the budget. Starts from 1 and increments by 1.

ActualSpend float64

The actual spend in currency for the current budget cycle.

AlertRuleCount int

The total number of alert rules in the budget.

ForecastedSpend float64

The forecasted spend in currency by the end of the current budget cycle.

Id string

The provider-assigned unique ID for this managed resource.

State string

The current state of the budget.

TimeCreated string

The time that the budget was created.

TimeSpendComputed string

The time that the budget spend was last computed.

TimeUpdated string

The time that the budget was updated.

Version int

The version of the budget. Starts from 1 and increments by 1.

actualSpend Double

The actual spend in currency for the current budget cycle.

alertRuleCount Integer

The total number of alert rules in the budget.

forecastedSpend Double

The forecasted spend in currency by the end of the current budget cycle.

id String

The provider-assigned unique ID for this managed resource.

state String

The current state of the budget.

timeCreated String

The time that the budget was created.

timeSpendComputed String

The time that the budget spend was last computed.

timeUpdated String

The time that the budget was updated.

version Integer

The version of the budget. Starts from 1 and increments by 1.

actualSpend number

The actual spend in currency for the current budget cycle.

alertRuleCount number

The total number of alert rules in the budget.

forecastedSpend number

The forecasted spend in currency by the end of the current budget cycle.

id string

The provider-assigned unique ID for this managed resource.

state string

The current state of the budget.

timeCreated string

The time that the budget was created.

timeSpendComputed string

The time that the budget spend was last computed.

timeUpdated string

The time that the budget was updated.

version number

The version of the budget. Starts from 1 and increments by 1.

actual_spend float

The actual spend in currency for the current budget cycle.

alert_rule_count int

The total number of alert rules in the budget.

forecasted_spend float

The forecasted spend in currency by the end of the current budget cycle.

id str

The provider-assigned unique ID for this managed resource.

state str

The current state of the budget.

time_created str

The time that the budget was created.

time_spend_computed str

The time that the budget spend was last computed.

time_updated str

The time that the budget was updated.

version int

The version of the budget. Starts from 1 and increments by 1.

actualSpend Number

The actual spend in currency for the current budget cycle.

alertRuleCount Number

The total number of alert rules in the budget.

forecastedSpend Number

The forecasted spend in currency by the end of the current budget cycle.

id String

The provider-assigned unique ID for this managed resource.

state String

The current state of the budget.

timeCreated String

The time that the budget was created.

timeSpendComputed String

The time that the budget spend was last computed.

timeUpdated String

The time that the budget was updated.

version Number

The version of the budget. Starts from 1 and increments by 1.

Look up Existing Budget Resource

Get an existing Budget 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?: BudgetState, opts?: CustomResourceOptions): Budget
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        actual_spend: Optional[float] = None,
        alert_rule_count: Optional[int] = None,
        amount: Optional[int] = None,
        budget_processing_period_start_offset: Optional[int] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        forecasted_spend: Optional[float] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        processing_period_type: Optional[str] = None,
        reset_period: Optional[str] = None,
        state: Optional[str] = None,
        target_compartment_id: Optional[str] = None,
        target_type: Optional[str] = None,
        targets: Optional[Sequence[str]] = None,
        time_created: Optional[str] = None,
        time_spend_computed: Optional[str] = None,
        time_updated: Optional[str] = None,
        version: Optional[int] = None) -> Budget
func GetBudget(ctx *Context, name string, id IDInput, state *BudgetState, opts ...ResourceOption) (*Budget, error)
public static Budget Get(string name, Input<string> id, BudgetState? state, CustomResourceOptions? opts = null)
public static Budget get(String name, Output<String> id, BudgetState 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:
ActualSpend double

The actual spend in currency for the current budget cycle.

AlertRuleCount int

The total number of alert rules in the budget.

Amount int

(Updatable) The amount of the budget expressed as a whole number in the currency of the customer's rate card.

BudgetProcessingPeriodStartOffset int

(Updatable) The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

CompartmentId string

The OCID of the compartment.

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 budget.

DisplayName string

(Updatable) The displayName of the budget. Avoid entering confidential information.

ForecastedSpend double

The forecasted spend in currency by the end of the current budget cycle.

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"}

ProcessingPeriodType string

(Updatable) The type of the budget processing period. Valid values are INVOICE and MONTH.

ResetPeriod string

(Updatable) The reset period for the budget. Valid value is MONTHLY.

State string

The current state of the budget.

TargetCompartmentId string

This is DEPRECATED. Set the target compartment ID in targets instead.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

TargetType string

The type of target on which the budget is applied.

Targets List<string>

The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.

TimeCreated string

The time that the budget was created.

TimeSpendComputed string

The time that the budget spend was last computed.

TimeUpdated string

The time that the budget was updated.

Version int

The version of the budget. Starts from 1 and increments by 1.

ActualSpend float64

The actual spend in currency for the current budget cycle.

AlertRuleCount int

The total number of alert rules in the budget.

Amount int

(Updatable) The amount of the budget expressed as a whole number in the currency of the customer's rate card.

BudgetProcessingPeriodStartOffset int

(Updatable) The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

CompartmentId string

The OCID of the compartment.

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 budget.

DisplayName string

(Updatable) The displayName of the budget. Avoid entering confidential information.

ForecastedSpend float64

The forecasted spend in currency by the end of the current budget cycle.

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"}

ProcessingPeriodType string

(Updatable) The type of the budget processing period. Valid values are INVOICE and MONTH.

ResetPeriod string

(Updatable) The reset period for the budget. Valid value is MONTHLY.

State string

The current state of the budget.

TargetCompartmentId string

This is DEPRECATED. Set the target compartment ID in targets instead.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

TargetType string

The type of target on which the budget is applied.

Targets []string

The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.

TimeCreated string

The time that the budget was created.

TimeSpendComputed string

The time that the budget spend was last computed.

TimeUpdated string

The time that the budget was updated.

Version int

The version of the budget. Starts from 1 and increments by 1.

actualSpend Double

The actual spend in currency for the current budget cycle.

alertRuleCount Integer

The total number of alert rules in the budget.

amount Integer

(Updatable) The amount of the budget expressed as a whole number in the currency of the customer's rate card.

budgetProcessingPeriodStartOffset Integer

(Updatable) The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

compartmentId String

The OCID of the compartment.

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 budget.

displayName String

(Updatable) The displayName of the budget. Avoid entering confidential information.

forecastedSpend Double

The forecasted spend in currency by the end of the current budget cycle.

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"}

processingPeriodType String

(Updatable) The type of the budget processing period. Valid values are INVOICE and MONTH.

resetPeriod String

(Updatable) The reset period for the budget. Valid value is MONTHLY.

state String

The current state of the budget.

targetCompartmentId String

This is DEPRECATED. Set the target compartment ID in targets instead.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

targetType String

The type of target on which the budget is applied.

targets List<String>

The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.

timeCreated String

The time that the budget was created.

timeSpendComputed String

The time that the budget spend was last computed.

timeUpdated String

The time that the budget was updated.

version Integer

The version of the budget. Starts from 1 and increments by 1.

actualSpend number

The actual spend in currency for the current budget cycle.

alertRuleCount number

The total number of alert rules in the budget.

amount number

(Updatable) The amount of the budget expressed as a whole number in the currency of the customer's rate card.

budgetProcessingPeriodStartOffset number

(Updatable) The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

compartmentId string

The OCID of the compartment.

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 budget.

displayName string

(Updatable) The displayName of the budget. Avoid entering confidential information.

forecastedSpend number

The forecasted spend in currency by the end of the current budget cycle.

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"}

processingPeriodType string

(Updatable) The type of the budget processing period. Valid values are INVOICE and MONTH.

resetPeriod string

(Updatable) The reset period for the budget. Valid value is MONTHLY.

state string

The current state of the budget.

targetCompartmentId string

This is DEPRECATED. Set the target compartment ID in targets instead.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

targetType string

The type of target on which the budget is applied.

targets string[]

The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.

timeCreated string

The time that the budget was created.

timeSpendComputed string

The time that the budget spend was last computed.

timeUpdated string

The time that the budget was updated.

version number

The version of the budget. Starts from 1 and increments by 1.

actual_spend float

The actual spend in currency for the current budget cycle.

alert_rule_count int

The total number of alert rules in the budget.

amount int

(Updatable) The amount of the budget expressed as a whole number in the currency of the customer's rate card.

budget_processing_period_start_offset int

(Updatable) The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

compartment_id str

The OCID of the compartment.

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 budget.

display_name str

(Updatable) The displayName of the budget. Avoid entering confidential information.

forecasted_spend float

The forecasted spend in currency by the end of the current budget cycle.

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"}

processing_period_type str

(Updatable) The type of the budget processing period. Valid values are INVOICE and MONTH.

reset_period str

(Updatable) The reset period for the budget. Valid value is MONTHLY.

state str

The current state of the budget.

target_compartment_id str

This is DEPRECATED. Set the target compartment ID in targets instead.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

target_type str

The type of target on which the budget is applied.

targets Sequence[str]

The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.

time_created str

The time that the budget was created.

time_spend_computed str

The time that the budget spend was last computed.

time_updated str

The time that the budget was updated.

version int

The version of the budget. Starts from 1 and increments by 1.

actualSpend Number

The actual spend in currency for the current budget cycle.

alertRuleCount Number

The total number of alert rules in the budget.

amount Number

(Updatable) The amount of the budget expressed as a whole number in the currency of the customer's rate card.

budgetProcessingPeriodStartOffset Number

(Updatable) The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

compartmentId String

The OCID of the compartment.

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 budget.

displayName String

(Updatable) The displayName of the budget. Avoid entering confidential information.

forecastedSpend Number

The forecasted spend in currency by the end of the current budget cycle.

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"}

processingPeriodType String

(Updatable) The type of the budget processing period. Valid values are INVOICE and MONTH.

resetPeriod String

(Updatable) The reset period for the budget. Valid value is MONTHLY.

state String

The current state of the budget.

targetCompartmentId String

This is DEPRECATED. Set the target compartment ID in targets instead.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

targetType String

The type of target on which the budget is applied.

targets List<String>

The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.

timeCreated String

The time that the budget was created.

timeSpendComputed String

The time that the budget spend was last computed.

timeUpdated String

The time that the budget was updated.

version Number

The version of the budget. Starts from 1 and increments by 1.

Import

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

 $ pulumi import oci:Budget/budget:Budget test_budget "id"

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.