Class: Aws::Deadline::Types::CreateLimitRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:description]

Instance Attribute Summary collapse

Instance Attribute Details

#amount_requirement_name ⇒ String

The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.

Returns:

  • (String) 


1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1411

class CreateLimitRequest < Struct.new(
  :client_token,
  :display_name,
  :amount_requirement_name,
  :max_count,
  :farm_id,
  :description)
  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) 


1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1411

class CreateLimitRequest < Struct.new(
  :client_token,
  :display_name,
  :amount_requirement_name,
  :max_count,
  :farm_id,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

A description of the limit. A description helps you identify the purpose of the limit.

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) 


1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1411

class CreateLimitRequest < Struct.new(
  :client_token,
  :display_name,
  :amount_requirement_name,
  :max_count,
  :farm_id,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#display_name ⇒ String

The display name of the limit.

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) 


1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1411

class CreateLimitRequest < Struct.new(
  :client_token,
  :display_name,
  :amount_requirement_name,
  :max_count,
  :farm_id,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#farm_id ⇒ String

The farm ID of the farm that contains the limit.

Returns:

  • (String) 


1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1411

class CreateLimitRequest < Struct.new(
  :client_token,
  :display_name,
  :amount_requirement_name,
  :max_count,
  :farm_id,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#max_count ⇒ Integer

The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.

The maxCount must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.

Returns:

  • (Integer) 


1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1411

class CreateLimitRequest < Struct.new(
  :client_token,
  :display_name,
  :amount_requirement_name,
  :max_count,
  :farm_id,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end