pulumi-aws-kotlin/com.pulumi.aws.budgets.kotlin/Budget

Budget

class Budget : KotlinCustomResource

Provides a budgets budget resource. Budgets use the cost visualisation provided by Cost Explorer to show you the status of your budgets, to provide forecasts of your estimated costs, and to track your AWS usage, including your free tier usage.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.budgets.Budget;
import com.pulumi.aws.budgets.BudgetArgs;
import com.pulumi.aws.budgets.inputs.BudgetCostFilterArgs;
import com.pulumi.aws.budgets.inputs.BudgetNotificationArgs;
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 ec2 = new Budget("ec2", BudgetArgs.builder()
            .budgetType("COST")
            .costFilters(BudgetCostFilterArgs.builder()
                .name("Service")
                .values("Amazon Elastic Compute Cloud - Compute")
                .build())
            .limitAmount("1200")
            .limitUnit("USD")
            .notifications(BudgetNotificationArgs.builder()
                .comparisonOperator("GREATER_THAN")
                .notificationType("FORECASTED")
                .subscriberEmailAddresses("test@example.com")
                .threshold(100)
                .thresholdType("PERCENTAGE")
                .build())
            .timePeriodEnd("2087-06-15_00:00")
            .timePeriodStart("2017-07-01_00:00")
            .timeUnit("MONTHLY")
            .build());
    }
}

Import

Budgets can be imported using AccountID:BudgetName, e.g.,

$ pulumi import aws:budgets/budget:Budget myBudget 123456789012:myBudget`

Properties

accountId

val accountId: Output<String>

The ID of the target account for budget. Will use current user's account_id by default if omitted.

arn

val arn: Output<String>

The ARN of the budget.

autoAdjustData

val autoAdjustData: Output<BudgetAutoAdjustData>?

Object containing AutoAdjustData which determines the budget amount for an auto-adjusting budget.

budgetType

val budgetType: Output<String>

Whether this budget tracks monetary cost or usage.

costFilterLegacy

val ~~costFilterLegacy~~: Output<Map<String, String>>

Map of CostFilters key/value pairs to apply to the budget.

costFilters

val costFilters: Output<List<BudgetCostFilter>>

A list of CostFilter name/values pair to apply to budget.

costTypes

val costTypes: Output<BudgetCostTypes>

Object containing CostTypes The types of cost included in a budget, such as tax and subscriptions.

val id: Output<String>

limitAmount

val limitAmount: Output<String>

The amount of cost or usage being measured for a budget.

limitUnit

val limitUnit: Output<String>

The unit of measurement used for the budget forecast, actual spend, or budget threshold, such as dollars or GB. See Spend documentation.

name

val name: Output<String>

The name of a budget. Unique within accounts.

namePrefix

val namePrefix: Output<String>

The prefix of the name of a budget. Unique within accounts.

notifications

val notifications: Output<List<BudgetNotification>>?

Object containing Budget Notifications. Can be used multiple times to define more than one budget notification.

plannedLimits

val plannedLimits: Output<List<BudgetPlannedLimit>>?

Object containing Planned Budget Limits. Can be used multiple times to plan more than one budget limit. See PlannedBudgetLimits documentation.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

timePeriodEnd

val timePeriodEnd: Output<String>?

The end of the time period covered by the budget. There are no restrictions on the end date. Format: 2017-01-01_12:00.

timePeriodStart

val timePeriodStart: Output<String>

The start of the time period covered by the budget. If you don't specify a start date, AWS defaults to the start of your chosen time period. The start date must come before the end date. Format: 2017-01-01_12:00.

timeUnit

val timeUnit: Output<String>

The length of time until a budget resets the actual and forecasted spend. Valid values: MONTHLY, QUARTERLY, ANNUALLY, and DAILY.

urn

val urn: Output<String>