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

Class: Aws::Budgets::Types::CreateBudgetRequest

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 CreateBudgetRequest data as a hash:

{
  account_id: "AccountId", # required
  budget: { # required
    budget_name: "BudgetName", # required
    budget_limit: {
      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,
      include_discount: false,
      use_amortized: false,
    },
    time_unit: "DAILY", # required, accepts DAILY, MONTHLY, QUARTERLY, ANNUALLY
    time_period: {
      start: Time.now,
      end: Time.now,
    },
    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, RI_COVERAGE
  },
  notifications_with_subscribers: [
    {
      notification: { # required
        notification_type: "ACTUAL", # required, accepts ACTUAL, FORECASTED
        comparison_operator: "GREATER_THAN", # required, accepts GREATER_THAN, LESS_THAN, EQUAL_TO
        threshold: 1.0, # required
        threshold_type: "PERCENTAGE", # accepts PERCENTAGE, ABSOLUTE_VALUE
      },
      subscribers: [ # required
        {
          subscription_type: "SNS", # required, accepts SNS, EMAIL
          address: "SubscriberAddress", # required
        },
      ],
    },
  ],
}

Request of CreateBudget

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

The accountId that is associated with the budget.

Returns:

  • (String) 


348
349
350
351
352
353
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 348

class CreateBudgetRequest < Struct.new(
  :account_id,
  :budget,
  :notifications_with_subscribers)
  include Aws::Structure
end

#budget ⇒ Types::Budget

The budget object that you want to create.

Returns:



348
349
350
351
352
353
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 348

class CreateBudgetRequest < Struct.new(
  :account_id,
  :budget,
  :notifications_with_subscribers)
  include Aws::Structure
end

#notifications_with_subscribers ⇒ Array<Types::NotificationWithSubscribers>

A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to ten email subscribers. If you include notifications and subscribers in your CreateBudget call, AWS creates the notifications and subscribers for you.

Returns:



348
349
350
351
352
353
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 348

class CreateBudgetRequest < Struct.new(
  :account_id,
  :budget,
  :notifications_with_subscribers)
  include Aws::Structure
end