Class Budget

Budget configuration for a billing account.

To get more information about Budget, see:

• API documentation
• How-to Guides
• Creating a budget

Inheritance

System.Object

Resource

CustomResource

Budget

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Billing

Assembly: Pulumi.Gcp.dll

Syntax

public class Budget : CustomResource

Constructors

Budget(String, BudgetArgs, CustomResourceOptions)

Create a Budget resource with the given unique name, arguments, and options.

Declaration

public Budget(string name, BudgetArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
BudgetArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AllUpdatesRule

Defines notifications that are sent on every update to the billing account's spend, regardless of the thresholds defined using threshold rules. Structure is documented below.

Declaration

public Output<BudgetAllUpdatesRule> AllUpdatesRule { get; }

Property Value

Type	Description
Output<BudgetAllUpdatesRule>

Amount

The budgeted amount for each usage period. Structure is documented below.

Declaration

public Output<BudgetAmount> Amount { get; }

Property Value

Type	Description
Output<BudgetAmount>

BillingAccount

ID of the billing account to set a budget on.

Declaration

public Output<string> BillingAccount { get; }

Property Value

Type	Description
Output<System.String>

BudgetFilter

Filters that define which resources are used to compute the actual spend against the budget. Structure is documented below.

Declaration

public Output<BudgetBudgetFilter> BudgetFilter { get; }

Property Value

Type	Description
Output<BudgetBudgetFilter>

DisplayName

User data for display name in UI. Must be <= 60 chars.

Declaration

public Output<string> DisplayName { get; }

Property Value

Type	Description
Output<System.String>

Name

Resource name of the budget. The resource name implies the scope of a budget. Values are of the form billingAccounts/{billingAccountId}/budgets/{budgetId}.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ThresholdRules

Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Structure is documented below.

Declaration

public Output<ImmutableArray<BudgetThresholdRule>> ThresholdRules { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<BudgetThresholdRule>>

Methods

Get(String, Input<String>, BudgetState, CustomResourceOptions)

Get an existing Budget resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Budget Get(string name, Input<string> id, BudgetState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
BudgetState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Budget