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: { # 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
  },
  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: "GenericString", # required
        },
      ],
    },
  ],
}

Request of CreateBudget

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

Account Id of the customer. It should be a 12 digit number.

Returns:

  • (String)


224
225
226
227
228
229
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 224

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

#budgetTypes::Budget

AWS Budget model

Returns:



224
225
226
227
228
229
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 224

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

#notifications_with_subscribersArray<Types::NotificationWithSubscribers>

A list of Notifications, each with a list of subscribers.



224
225
226
227
228
229
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 224

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