Class: Aws::Deadline::Types::CreateBudgetRequest

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

Overview

Shared displayName + description for Create operations where both are present. displayName is @required here - this mixin is Create-only by design (Update has optional displayName).

See Also:

Constant Summary collapse

SENSITIVE = 
[:description]

Instance Attribute Summary collapse

Instance Attribute Details

#actions ⇒ Array<Types::BudgetActionToAdd>

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

Returns:



2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 2566

class CreateBudgetRequest < Struct.new(
  :farm_id,
  :display_name,
  :description,
  :client_token,
  :usage_tracking_resource,
  :approximate_dollar_limit,
  :actions,
  :schedule,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#approximate_dollar_limit ⇒ Float

The dollar limit based on consumed usage.

Returns:

  • (Float) 


2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 2566

class CreateBudgetRequest < Struct.new(
  :farm_id,
  :display_name,
  :description,
  :client_token,
  :usage_tracking_resource,
  :approximate_dollar_limit,
  :actions,
  :schedule,
  :tags)
  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) 


2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 2566

class CreateBudgetRequest < Struct.new(
  :farm_id,
  :display_name,
  :description,
  :client_token,
  :usage_tracking_resource,
  :approximate_dollar_limit,
  :actions,
  :schedule,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

The description of the budget.

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) 


2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 2566

class CreateBudgetRequest < Struct.new(
  :farm_id,
  :display_name,
  :description,
  :client_token,
  :usage_tracking_resource,
  :approximate_dollar_limit,
  :actions,
  :schedule,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#display_name ⇒ String

The display name of the budget.

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) 


2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 2566

class CreateBudgetRequest < Struct.new(
  :farm_id,
  :display_name,
  :description,
  :client_token,
  :usage_tracking_resource,
  :approximate_dollar_limit,
  :actions,
  :schedule,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#farm_id ⇒ String

The farm ID to include in this budget.

Returns:

  • (String) 


2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 2566

class CreateBudgetRequest < Struct.new(
  :farm_id,
  :display_name,
  :description,
  :client_token,
  :usage_tracking_resource,
  :approximate_dollar_limit,
  :actions,
  :schedule,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#schedule ⇒ Types::BudgetSchedule

The schedule to associate with this budget.

Returns:



2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 2566

class CreateBudgetRequest < Struct.new(
  :farm_id,
  :display_name,
  :description,
  :client_token,
  :usage_tracking_resource,
  :approximate_dollar_limit,
  :actions,
  :schedule,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

Returns:

  • (Hash<String,String>) 


2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 2566

class CreateBudgetRequest < Struct.new(
  :farm_id,
  :display_name,
  :description,
  :client_token,
  :usage_tracking_resource,
  :approximate_dollar_limit,
  :actions,
  :schedule,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#usage_tracking_resource ⇒ Types::UsageTrackingResource

The queue ID provided to this budget to track usage.

Returns:



2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 2566

class CreateBudgetRequest < Struct.new(
  :farm_id,
  :display_name,
  :description,
  :client_token,
  :usage_tracking_resource,
  :approximate_dollar_limit,
  :actions,
  :schedule,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end