Class: AWSCDK::Deadline::CfnLimitProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
deadline/cfn_limit_props.rb

Overview

Properties for defining a CfnLimit.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(amount_requirement_name:, display_name:, farm_id:, max_count:, description: nil) ⇒ CfnLimitProps

Returns a new instance of CfnLimitProps.

Parameters:

  • 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.

  • display_name (String) —

    The name of the limit used in lists to identify the limit.

  • farm_id (String) —

    The unique identifier of the farm that contains the limit.

  • max_count (Numeric) —

    The maximum number of resources constrained by this limit.

  • description (String, nil) (defaults to: nil) —

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



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'deadline/cfn_limit_props.rb', line 14

def initialize(amount_requirement_name:, display_name:, farm_id:, max_count:, description: nil)
  @amount_requirement_name = amount_requirement_name
  Jsii::Type.check_type(@amount_requirement_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "amountRequirementName")
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName")
  @farm_id = farm_id
  Jsii::Type.check_type(@farm_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "farmId")
  @max_count = max_count
  Jsii::Type.check_type(@max_count, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxCount")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
end

Instance Attribute Details

#amount_requirement_name ⇒ String (readonly)

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)

See Also:



31
32
33
 
# File 'deadline/cfn_limit_props.rb', line 31

def amount_requirement_name
  @amount_requirement_name
end

#description ⇒ String? (readonly)

Note:

Default: - ""

A description of the limit. A clear 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, nil)

See Also:



60
61
62
 
# File 'deadline/cfn_limit_props.rb', line 60

def description
  @description
end

#display_name ⇒ String (readonly)

The name of the limit used in lists to identify 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)

See Also:



38
39
40
 
# File 'deadline/cfn_limit_props.rb', line 38

def display_name
  @display_name
end

#farm_id ⇒ String (readonly)

The unique identifier of the farm that contains the limit.

Returns:

  • (String)

See Also:



43
44
45
 
# File 'deadline/cfn_limit_props.rb', line 43

def farm_id
  @farm_id
end

#max_count ⇒ Numeric (readonly)

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 max_value 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:

  • (Numeric)

See Also:



52
53
54
 
# File 'deadline/cfn_limit_props.rb', line 52

def max_count
  @max_count
end

Class Method Details

.jsii_properties ⇒ Object 



62
63
64
65
66
67
68
69
70
 
# File 'deadline/cfn_limit_props.rb', line 62

def self.jsii_properties
  {
    :amount_requirement_name => "amountRequirementName",
    :display_name => "displayName",
    :farm_id => "farmId",
    :max_count => "maxCount",
    :description => "description",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
 
# File 'deadline/cfn_limit_props.rb', line 72

def to_jsii
  result = {}
  result.merge!({
    "amountRequirementName" => @amount_requirement_name,
    "displayName" => @display_name,
    "farmId" => @farm_id,
    "maxCount" => @max_count,
    "description" => @description,
  })
  result.compact
end