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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb

Overview

Note:

When making an API call, you may pass Budget data as a hash:

{
  budget_name: "BudgetName", # required
  budget_limit: { # required
    amount: "NumericValue", # required
    unit: "UnitValue", # required
  },
  cost_filters: {
    "GenericString" => ["GenericString"],
  },
  cost_types: { # required
    include_tax: false, # required
    include_subscription: false, # required
    use_blended: false, # required
  },
  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

Instance Attribute Summary collapse

Instance Attribute Details

#budget_limitTypes::Spend

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

Returns:



82
83
84
85
86
87
88
89
90
91
92
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 82

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type)
  include Aws::Structure
end

#budget_nameString

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

Returns:

  • (String)


82
83
84
85
86
87
88
89
90
91
92
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 82

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type)
  include Aws::Structure
end

#budget_typeString

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

Returns:

  • (String)


82
83
84
85
86
87
88
89
90
91
92
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 82

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type)
  include Aws::Structure
end

#calculated_spendTypes::CalculatedSpend

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



82
83
84
85
86
87
88
89
90
91
92
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 82

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type)
  include Aws::Structure
end

#cost_filtersHash<String,Array<String>>

A map represents the cost filters applied to the budget.

Returns:

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


82
83
84
85
86
87
88
89
90
91
92
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 82

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type)
  include Aws::Structure
end

#cost_typesTypes::CostTypes

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

Returns:



82
83
84
85
86
87
88
89
90
91
92
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 82

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type)
  include Aws::Structure
end

#time_periodTypes::TimePeriod

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

Returns:



82
83
84
85
86
87
88
89
90
91
92
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 82

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type)
  include Aws::Structure
end

#time_unitString

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

Returns:

  • (String)


82
83
84
85
86
87
88
89
90
91
92
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 82

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type)
  include Aws::Structure
end