Class: Aws::Deadline::Types::UpdateBudgetRequest

Inherits:

Struct

• Object
• Struct
• Aws::Deadline::Types::UpdateBudgetRequest

Defined in:

gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:description]

Instance Attribute Summary

• #actions_to_add ⇒ Array<Types::BudgetActionToAdd>

  The budget actions to add.

• #actions_to_remove ⇒ Array<Types::BudgetActionToRemove>

  The budget actions to remove from the budget.

• #approximate_dollar_limit ⇒ Float

  The dollar limit to update on the budget.

• #budget_id ⇒ String

  The budget ID to update.

• #client_token ⇒ String

  The unique token which the server uses to recognize retries of the same request.

• #description ⇒ String

  The description of the budget to update.

• #display_name ⇒ String

  The display name of the budget to update.

• #farm_id ⇒ String

  The farm ID of the budget to update.

• #schedule ⇒ Types::BudgetSchedule

  The schedule to update.

• #status ⇒ String

  Updates the status of the budget.

Instance Attribute Details

#actions_to_add ⇒ Array<Types::BudgetActionToAdd>

The budget actions to add. Budget actions specify what happens when the budget runs out.

Returns:

• (Array<Types::BudgetActionToAdd>)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 11880

class UpdateBudgetRequest < Struct.new(
  :farm_id,
  :budget_id,
  :client_token,
  :display_name,
  :description,
  :status,
  :approximate_dollar_limit,
  :actions_to_add,
  :actions_to_remove,
  :schedule)
  SENSITIVE = [:description]
  include Aws::Structure
end

#actions_to_remove ⇒ Array<Types::BudgetActionToRemove>

The budget actions to remove from the budget.

Returns:

• (Array<Types::BudgetActionToRemove>)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 11880

class UpdateBudgetRequest < Struct.new(
  :farm_id,
  :budget_id,
  :client_token,
  :display_name,
  :description,
  :status,
  :approximate_dollar_limit,
  :actions_to_add,
  :actions_to_remove,
  :schedule)
  SENSITIVE = [:description]
  include Aws::Structure
end

#approximate_dollar_limit ⇒ Float

The dollar limit to update on the budget. Based on consumed usage.

Returns:

• (Float)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 11880

class UpdateBudgetRequest < Struct.new(
  :farm_id,
  :budget_id,
  :client_token,
  :display_name,
  :description,
  :status,
  :approximate_dollar_limit,
  :actions_to_add,
  :actions_to_remove,
  :schedule)
  SENSITIVE = [:description]
  include Aws::Structure
end

#budget_id ⇒ String

The budget ID to update.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 11880

class UpdateBudgetRequest < Struct.new(
  :farm_id,
  :budget_id,
  :client_token,
  :display_name,
  :description,
  :status,
  :approximate_dollar_limit,
  :actions_to_add,
  :actions_to_remove,
  :schedule)
  SENSITIVE = [:description]
  include Aws::Structure
end

#client_token ⇒ String

The unique token which the server uses to recognize retries of the same request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 11880

class UpdateBudgetRequest < Struct.new(
  :farm_id,
  :budget_id,
  :client_token,
  :display_name,
  :description,
  :status,
  :approximate_dollar_limit,
  :actions_to_add,
  :actions_to_remove,
  :schedule)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

The description of the budget to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 11880

class UpdateBudgetRequest < Struct.new(
  :farm_id,
  :budget_id,
  :client_token,
  :display_name,
  :description,
  :status,
  :approximate_dollar_limit,
  :actions_to_add,
  :actions_to_remove,
  :schedule)
  SENSITIVE = [:description]
  include Aws::Structure
end

#display_name ⇒ String

The display name of the budget to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 11880

class UpdateBudgetRequest < Struct.new(
  :farm_id,
  :budget_id,
  :client_token,
  :display_name,
  :description,
  :status,
  :approximate_dollar_limit,
  :actions_to_add,
  :actions_to_remove,
  :schedule)
  SENSITIVE = [:description]
  include Aws::Structure
end

#farm_id ⇒ String

The farm ID of the budget to update.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 11880

class UpdateBudgetRequest < Struct.new(
  :farm_id,
  :budget_id,
  :client_token,
  :display_name,
  :description,
  :status,
  :approximate_dollar_limit,
  :actions_to_add,
  :actions_to_remove,
  :schedule)
  SENSITIVE = [:description]
  include Aws::Structure
end

#schedule ⇒ Types::BudgetSchedule

The schedule to update.

Returns:

• (Types::BudgetSchedule)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 11880

class UpdateBudgetRequest < Struct.new(
  :farm_id,
  :budget_id,
  :client_token,
  :display_name,
  :description,
  :status,
  :approximate_dollar_limit,
  :actions_to_add,
  :actions_to_remove,
  :schedule)
  SENSITIVE = [:description]
  include Aws::Structure
end

#status ⇒ String

Updates the status of the budget.

• ACTIVE–The budget is being evaluated.

• INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 11880

class UpdateBudgetRequest < Struct.new(
  :farm_id,
  :budget_id,
  :client_token,
  :display_name,
  :description,
  :status,
  :approximate_dollar_limit,
  :actions_to_add,
  :actions_to_remove,
  :schedule)
  SENSITIVE = [:description]
  include Aws::Structure
end