You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Budgets::Types::Budget

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Budget as input to an Aws::Client method, you can use a vanilla Hash:

{
  budget_name: "BudgetName", # required
  budget_limit: { # required
    amount: "NumericValue", # required
    unit: "UnitValue", # required
  },
  cost_filters: {
    "GenericString" => ["GenericString"],
  },
  cost_types: {
    include_tax: false,
    include_subscription: false,
    use_blended: false,
    include_refund: false,
    include_credit: false,
    include_upfront: false,
    include_recurring: false,
    include_other_subscription: false,
    include_support: false,
  },
  time_unit: "DAILY", # required, accepts DAILY, MONTHLY, QUARTERLY, ANNUALLY
  time_period: { # required
    start: Time.now, # required
    end: Time.now, # required
  },
  calculated_spend: {
    actual_spend: { # required
      amount: "NumericValue", # required
      unit: "UnitValue", # required
    },
    forecasted_spend: {
      amount: "NumericValue", # required
      unit: "UnitValue", # required
    },
  },
  budget_type: "USAGE", # required, accepts USAGE, COST, RI_UTILIZATION
}

AWS Budget model

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#budget_limitTypes::Spend

A structure that represents either a cost spend or usage spend. Contains an amount and a unit.

Returns:

  • (Types::Spend)

    A structure that represents either a cost spend or usage spend.

#budget_nameString

A string represents the budget name. No ":" and "\" character is allowed.

Returns:

  • (String)

    A string represents the budget name.

#budget_typeString

The type of a budget. It should be COST, USAGE, or RI_UTILIZATION.

Possible values:

  • USAGE
  • COST
  • RI_UTILIZATION

Returns:

  • (String)

    The type of a budget.

#calculated_spendTypes::CalculatedSpend

A structure that holds the actual and forecasted spend for a budget.

Returns:

#cost_filtersHash<String,Array<String>>

A map that represents the cost filters applied to the budget.

Returns:

  • (Hash<String,Array<String>>)

    A map that represents the cost filters applied to the budget.

#cost_typesTypes::CostTypes

This includes the options for getting the cost of a budget.

Returns:

  • (Types::CostTypes)

    This includes the options for getting the cost of a budget.

#time_periodTypes::TimePeriod

A time period indicating the start date and end date of a budget.

Returns:

  • (Types::TimePeriod)

    A time period indicating the start date and end date of a budget.

#time_unitString

The time unit of the budget. e.g. MONTHLY, QUARTERLY, etc.

Possible values:

  • DAILY
  • MONTHLY
  • QUARTERLY
  • ANNUALLY

Returns:

  • (String)

    The time unit of the budget.