Module budgets

budgets

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.
class pulumi_aws.budgets.Budget(resource_name, opts=None, account_id=None, budget_type=None, cost_filters=None, cost_types=None, limit_amount=None, limit_unit=None, name=None, name_prefix=None, notifications=None, time_period_end=None, time_period_start=None, time_unit=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • account_id (pulumi.Input[str]) – The ID of the target account for budget. Will use current user’s account_id by default if omitted.
  • budget_type (pulumi.Input[str]) – Whether this budget tracks monetary cost or usage.
  • cost_filters (pulumi.Input[dict]) – Map of CostFilters key/value pairs to apply to the budget.
  • cost_types (pulumi.Input[dict]) – Object containing CostTypes The types of cost included in a budget, such as tax and subscriptions..
  • limit_amount (pulumi.Input[str]) – The amount of cost or usage being measured for a budget.
  • limit_unit (pulumi.Input[str]) – The unit of measurement used for the budget forecast, actual spend, or budget threshold, such as dollars or GB. See Spend documentation.
  • name (pulumi.Input[str]) – The name of a budget. Unique within accounts.
  • name_prefix (pulumi.Input[str]) – The prefix of the name of a budget. Unique within accounts.
  • notifications (pulumi.Input[list]) – Object containing Budget Notifications. Can be used multiple times to define more than one budget notification
  • time_period_end (pulumi.Input[str]) – The end of the time period covered by the budget. There are no restrictions on the end date. Format: 2017-01-01_12:00.
  • time_period_start (pulumi.Input[str]) – The start of the time period covered by the budget. The start date must come before the end date. Format: 2017-01-01_12:00.
  • time_unit (pulumi.Input[str]) – The length of time until a budget resets the actual and forecasted spend. Valid values: MONTHLY, QUARTERLY, ANNUALLY.
account_id = None

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

budget_type = None

Whether this budget tracks monetary cost or usage.

cost_filters = None

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

cost_types = None

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

limit_amount = None

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

limit_unit = None

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

name = None

The name of a budget. Unique within accounts.

name_prefix = None

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

notifications = None

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

time_period_end = None

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

time_period_start = None

The start of the time period covered by the budget. The start date must come before the end date. Format: 2017-01-01_12:00.

time_unit = None

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

static get(resource_name, id, opts=None, account_id=None, budget_type=None, cost_filters=None, cost_types=None, limit_amount=None, limit_unit=None, name=None, name_prefix=None, notifications=None, time_period_end=None, time_period_start=None, time_unit=None)

Get an existing Budget resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] account_id: The ID of the target account for budget. Will use current user’s account_id by default if omitted. :param pulumi.Input[str] budget_type: Whether this budget tracks monetary cost or usage. :param pulumi.Input[dict] cost_filters: Map of CostFilters key/value pairs to apply to the budget. :param pulumi.Input[dict] cost_types: Object containing CostTypes The types of cost included in a budget, such as tax and subscriptions.. :param pulumi.Input[str] limit_amount: The amount of cost or usage being measured for a budget. :param pulumi.Input[str] limit_unit: The unit of measurement used for the budget forecast, actual spend, or budget threshold, such as dollars or GB. See Spend documentation. :param pulumi.Input[str] name: The name of a budget. Unique within accounts. :param pulumi.Input[str] name_prefix: The prefix of the name of a budget. Unique within accounts. :param pulumi.Input[list] notifications: Object containing Budget Notifications. Can be used multiple times to define more than one budget notification :param pulumi.Input[str] time_period_end: The end of the time period covered by the budget. There are no restrictions on the end date. Format: 2017-01-01_12:00. :param pulumi.Input[str] time_period_start: The start of the time period covered by the budget. The start date must come before the end date. Format: 2017-01-01_12:00. :param pulumi.Input[str] time_unit: The length of time until a budget resets the actual and forecasted spend. Valid values: MONTHLY, QUARTERLY, ANNUALLY.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str