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

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

Overview

Represents the output of the ‘CreateBudget` operation. The content consists of the detailed metadata and data file information, and the current status of the `budget` object.

This is the Amazon Resource Name (ARN) pattern for a budget:

‘arn:aws:budgets::AccountId:budget/budgetName`

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_adjust_data ⇒ Types::AutoAdjustData

The parameters that determine the budget amount for an auto-adjusting budget.

Returns:



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aws-sdk-budgets/types.rb', line 312

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :planned_budget_limits,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type,
  :last_updated_time,
  :auto_adjust_data)
  SENSITIVE = []
  include Aws::Structure
end

#budget_limit ⇒ Types::Spend

The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.

‘BudgetLimit` is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to `100`. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can’t use ‘BudgetLimit` with `PlannedBudgetLimits` for `CreateBudget` and `UpdateBudget` actions.

Returns:



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aws-sdk-budgets/types.rb', line 312

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :planned_budget_limits,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type,
  :last_updated_time,
  :auto_adjust_data)
  SENSITIVE = []
  include Aws::Structure
end

#budget_name ⇒ String

The name of a budget. The name must be unique within an account. The ‘:` and “ characters, and the “/action/” substring, aren’t allowed in ‘BudgetName`.

Returns:

  • (String) 


312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aws-sdk-budgets/types.rb', line 312

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :planned_budget_limits,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type,
  :last_updated_time,
  :auto_adjust_data)
  SENSITIVE = []
  include Aws::Structure
end

#budget_type ⇒ String

Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

Returns:

  • (String) 


312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aws-sdk-budgets/types.rb', line 312

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :planned_budget_limits,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type,
  :last_updated_time,
  :auto_adjust_data)
  SENSITIVE = []
  include Aws::Structure
end

#calculated_spend ⇒ Types::CalculatedSpend

The actual and forecasted cost or usage that the budget tracks.

Returns:



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aws-sdk-budgets/types.rb', line 312

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :planned_budget_limits,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type,
  :last_updated_time,
  :auto_adjust_data)
  SENSITIVE = []
  include Aws::Structure
end

#cost_filters ⇒ Hash<String,Array<String>>

The cost filters, such as ‘Region`, `Service`, `LinkedAccount`, `Tag`, or `CostCategory`, that are applied to a budget.

Amazon Web Services Budgets supports the following services as a ‘Service` filter for RI budgets:

  • Amazon EC2

  • Amazon Redshift

  • Amazon Relational Database Service

  • Amazon ElastiCache

  • Amazon OpenSearch Service

Returns:

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


312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aws-sdk-budgets/types.rb', line 312

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :planned_budget_limits,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type,
  :last_updated_time,
  :auto_adjust_data)
  SENSITIVE = []
  include Aws::Structure
end

#cost_types ⇒ Types::CostTypes

The types of costs that are included in this ‘COST` budget.

‘USAGE`, `RI_UTILIZATION`, `RI_COVERAGE`, `SAVINGS_PLANS_UTILIZATION`, and `SAVINGS_PLANS_COVERAGE` budgets do not have `CostTypes`.

Returns:



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aws-sdk-budgets/types.rb', line 312

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :planned_budget_limits,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type,
  :last_updated_time,
  :auto_adjust_data)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time ⇒ Time

The last time that you updated this budget.

Returns:

  • (Time) 


312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aws-sdk-budgets/types.rb', line 312

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :planned_budget_limits,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type,
  :last_updated_time,
  :auto_adjust_data)
  SENSITIVE = []
  include Aws::Structure
end

#planned_budget_limits ⇒ Hash<String,Types::Spend>

A map containing multiple ‘BudgetLimit`, including current or future limits.

‘PlannedBudgetLimits` is available for cost or usage budget and supports both monthly and quarterly `TimeUnit`.

For monthly budgets, provide 12 months of ‘PlannedBudgetLimits` values. This must start from the current month and include the next 11 months. The `key` is the start of the month, `UTC` in epoch seconds.

For quarterly budgets, provide four quarters of ‘PlannedBudgetLimits` value entries in standard calendar quarter increments. This must start from the current quarter and include the next three quarters. The `key` is the start of the quarter, `UTC` in epoch seconds.

If the planned budget expires before 12 months for monthly or four quarters for quarterly, provide the ‘PlannedBudgetLimits` values only for the remaining periods.

If the budget begins at a date in the future, provide ‘PlannedBudgetLimits` values from the start date of the budget.

After all of the ‘BudgetLimit` values in `PlannedBudgetLimits` are used, the budget continues to use the last limit as the `BudgetLimit`. At that point, the planned budget provides the same experience as a fixed budget.

‘DescribeBudget` and `DescribeBudgets` response along with `PlannedBudgetLimits` also contain `BudgetLimit` representing the current month or quarter limit present in `PlannedBudgetLimits`. This only applies to budgets that are created with `PlannedBudgetLimits`. Budgets that are created without `PlannedBudgetLimits` only contain `BudgetLimit`. They don’t contain ‘PlannedBudgetLimits`.

Returns:



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aws-sdk-budgets/types.rb', line 312

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :planned_budget_limits,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type,
  :last_updated_time,
  :auto_adjust_data)
  SENSITIVE = []
  include Aws::Structure
end

#time_period ⇒ Types::TimePeriod

The period of time that’s covered by a budget. You setthe start date and end date. The start date must come before the end date. The end date must come before ‘06/15/87 00:00 UTC`.

If you create your budget and don’t specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose ‘DAILY`, and didn’t set a start date, Amazon Web Services set your start date to ‘01/24/18 00:00 UTC`. If you chose `MONTHLY`, Amazon Web Services set your start date to `01/01/18 00:00 UTC`. If you didn’t specify an end date, Amazon Web Services set your end date to ‘06/15/87 00:00 UTC`. The defaults are the same for the Billing and Cost Management console and the API.

You can change either date with the ‘UpdateBudget` operation.

After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.

Returns:



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aws-sdk-budgets/types.rb', line 312

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :planned_budget_limits,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type,
  :last_updated_time,
  :auto_adjust_data)
  SENSITIVE = []
  include Aws::Structure
end

#time_unit ⇒ String

The length of time until a budget resets the actual and forecasted spend.

Returns:

  • (String) 


312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aws-sdk-budgets/types.rb', line 312

class Budget < Struct.new(
  :budget_name,
  :budget_limit,
  :planned_budget_limits,
  :cost_filters,
  :cost_types,
  :time_unit,
  :time_period,
  :calculated_spend,
  :budget_type,
  :last_updated_time,
  :auto_adjust_data)
  SENSITIVE = []
  include Aws::Structure
end