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

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

Overview

Constant Summary collapse

SENSITIVE =
[:description]

Instance Attribute Summary collapse

Instance Attribute Details

#actionsArray<Types::BudgetActionToAdd>

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

Returns:



979
980
981
982
983
984
985
986
987
988
989
990
# File 'lib/aws-sdk-deadline/types.rb', line 979

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

#approximate_dollar_limitFloat

The dollar limit based on consumed usage.

Returns:

  • (Float)


979
980
981
982
983
984
985
986
987
988
989
990
# File 'lib/aws-sdk-deadline/types.rb', line 979

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

#client_tokenString

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)


979
980
981
982
983
984
985
986
987
988
989
990
# File 'lib/aws-sdk-deadline/types.rb', line 979

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

#descriptionString

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)


979
980
981
982
983
984
985
986
987
988
989
990
# File 'lib/aws-sdk-deadline/types.rb', line 979

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

#display_nameString

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)


979
980
981
982
983
984
985
986
987
988
989
990
# File 'lib/aws-sdk-deadline/types.rb', line 979

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

#farm_idString

The farm ID to include in this budget.

Returns:

  • (String)


979
980
981
982
983
984
985
986
987
988
989
990
# File 'lib/aws-sdk-deadline/types.rb', line 979

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

#scheduleTypes::BudgetSchedule

The schedule to associate with this budget.



979
980
981
982
983
984
985
986
987
988
989
990
# File 'lib/aws-sdk-deadline/types.rb', line 979

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

#usage_tracking_resourceTypes::UsageTrackingResource

The queue ID provided to this budget to track usage.



979
980
981
982
983
984
985
986
987
988
989
990
# File 'lib/aws-sdk-deadline/types.rb', line 979

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