Class: AWSCDK::Deadline::CfnQueueProps

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

Overview

Properties for defining a CfnQueue.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(display_name:, farm_id:, allowed_storage_profile_ids: nil, default_budget_action: nil, description: nil, job_attachment_settings: nil, job_run_as_user: nil, required_file_system_location_names: nil, role_arn: nil, scheduling_configuration: nil, tags: nil) ⇒ CfnQueueProps

Returns a new instance of CfnQueueProps.

Parameters:

  • display_name (String) —

    The display name of the queue summary to update.

  • farm_id (String) —

    The farm ID.

  • allowed_storage_profile_ids (Array<String>, nil) (defaults to: nil) —

    The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.

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

    The default action taken on a queue summary if a budget wasn't configured.

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

    A description of the queue that helps identify what the queue is used for.

  • job_attachment_settings (AWSCDK::IResolvable, AWSCDK::Deadline::CfnQueue::JobAttachmentSettingsProperty, nil) (defaults to: nil) —

    The job attachment settings.

  • job_run_as_user (AWSCDK::IResolvable, AWSCDK::Deadline::CfnQueue::JobRunAsUserProperty, nil) (defaults to: nil) —

    Identifies the user for a job.

  • required_file_system_location_names (Array<String>, nil) (defaults to: nil) —

    The file system location that the queue uses.

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

    The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.

  • scheduling_configuration (AWSCDK::IResolvable, AWSCDK::Deadline::CfnQueue::SchedulingConfigurationProperty, nil) (defaults to: nil)
  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    The tags to add to your queue.



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'deadline/cfn_queue_props.rb', line 20

def initialize(display_name:, farm_id:, allowed_storage_profile_ids: nil, default_budget_action: nil, description: nil, job_attachment_settings: nil, job_run_as_user: nil, required_file_system_location_names: nil, role_arn: nil, scheduling_configuration: nil, tags: nil)
  @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")
  @allowed_storage_profile_ids = allowed_storage_profile_ids
  Jsii::Type.check_type(@allowed_storage_profile_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "allowedStorageProfileIds") unless @allowed_storage_profile_ids.nil?
  @default_budget_action = default_budget_action
  Jsii::Type.check_type(@default_budget_action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultBudgetAction") unless @default_budget_action.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @job_attachment_settings = job_attachment_settings.is_a?(Hash) ? ::AWSCDK::Deadline::CfnQueue::JobAttachmentSettingsProperty.new(**job_attachment_settings.transform_keys(&:to_sym)) : job_attachment_settings
  Jsii::Type.check_type(@job_attachment_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kZWFkbGluZS5DZm5RdWV1ZS5Kb2JBdHRhY2htZW50U2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "jobAttachmentSettings") unless @job_attachment_settings.nil?
  @job_run_as_user = job_run_as_user.is_a?(Hash) ? ::AWSCDK::Deadline::CfnQueue::JobRunAsUserProperty.new(**job_run_as_user.transform_keys(&:to_sym)) : job_run_as_user
  Jsii::Type.check_type(@job_run_as_user, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kZWFkbGluZS5DZm5RdWV1ZS5Kb2JSdW5Bc1VzZXJQcm9wZXJ0eSJ9XX19")), "jobRunAsUser") unless @job_run_as_user.nil?
  @required_file_system_location_names = required_file_system_location_names
  Jsii::Type.check_type(@required_file_system_location_names, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "requiredFileSystemLocationNames") unless @required_file_system_location_names.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
  @scheduling_configuration = scheduling_configuration.is_a?(Hash) ? ::AWSCDK::Deadline::CfnQueue::SchedulingConfigurationProperty.new(**scheduling_configuration.transform_keys(&:to_sym)) : scheduling_configuration
  Jsii::Type.check_type(@scheduling_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kZWFkbGluZS5DZm5RdWV1ZS5TY2hlZHVsaW5nQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "schedulingConfiguration") unless @scheduling_configuration.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#allowed_storage_profile_ids ⇒ Array<String>? (readonly)

The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.

Returns:

  • (Array<String>, nil)

See Also:



61
62
63
 
# File 'deadline/cfn_queue_props.rb', line 61

def allowed_storage_profile_ids
  @allowed_storage_profile_ids
end

#default_budget_action ⇒ String? (readonly)

Note:

Default: - "NONE"

The default action taken on a queue summary if a budget wasn't configured.

Returns:

  • (String, nil)

See Also:



67
68
69
 
# File 'deadline/cfn_queue_props.rb', line 67

def default_budget_action
  @default_budget_action
end

#description ⇒ String? (readonly)

Note:

Default: - ""

A description of the queue that helps identify what the queue is used for.

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:



75
76
77
 
# File 'deadline/cfn_queue_props.rb', line 75

def description
  @description
end

#display_name ⇒ String (readonly)

The display name of the queue summary 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)

See Also:



51
52
53
 
# File 'deadline/cfn_queue_props.rb', line 51

def display_name
  @display_name
end

#farm_id ⇒ String (readonly)

The farm ID.

Returns:

  • (String)

See Also:



56
57
58
 
# File 'deadline/cfn_queue_props.rb', line 56

def farm_id
  @farm_id
end

#job_attachment_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The job attachment settings.

These are the Amazon S3 bucket name and the Amazon S3 prefix.

Returns:

See Also:



82
83
84
 
# File 'deadline/cfn_queue_props.rb', line 82

def job_attachment_settings
  @job_attachment_settings
end

#job_run_as_user ⇒ AWSCDK::IResolvable, ... (readonly)

Identifies the user for a job.

Returns:

See Also:



87
88
89
 
# File 'deadline/cfn_queue_props.rb', line 87

def job_run_as_user
  @job_run_as_user
end

#required_file_system_location_names ⇒ Array<String>? (readonly)

The file system location that the queue uses.

Returns:

  • (Array<String>, nil)

See Also:



92
93
94
 
# File 'deadline/cfn_queue_props.rb', line 92

def required_file_system_location_names
  @required_file_system_location_names
end

#role_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.

Returns:

  • (String, nil)

See Also:



97
98
99
 
# File 'deadline/cfn_queue_props.rb', line 97

def role_arn
  @role_arn
end

#scheduling_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



100
101
102
 
# File 'deadline/cfn_queue_props.rb', line 100

def scheduling_configuration
  @scheduling_configuration
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags to add to your queue.

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:

See Also:



107
108
109
 
# File 'deadline/cfn_queue_props.rb', line 107

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'deadline/cfn_queue_props.rb', line 109

def self.jsii_properties
  {
    :display_name => "displayName",
    :farm_id => "farmId",
    :allowed_storage_profile_ids => "allowedStorageProfileIds",
    :default_budget_action => "defaultBudgetAction",
    :description => "description",
    :job_attachment_settings => "jobAttachmentSettings",
    :job_run_as_user => "jobRunAsUser",
    :required_file_system_location_names => "requiredFileSystemLocationNames",
    :role_arn => "roleArn",
    :scheduling_configuration => "schedulingConfiguration",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'deadline/cfn_queue_props.rb', line 125

def to_jsii
  result = {}
  result.merge!({
    "displayName" => @display_name,
    "farmId" => @farm_id,
    "allowedStorageProfileIds" => @allowed_storage_profile_ids,
    "defaultBudgetAction" => @default_budget_action,
    "description" => @description,
    "jobAttachmentSettings" => @job_attachment_settings,
    "jobRunAsUser" => @job_run_as_user,
    "requiredFileSystemLocationNames" => @required_file_system_location_names,
    "roleArn" => @role_arn,
    "schedulingConfiguration" => @scheduling_configuration,
    "tags" => @tags,
  })
  result.compact
end