Class: Aws::Deadline::Types::CreateQueueRequest

Inherits:

Struct

• Object
• Struct
• Aws::Deadline::Types::CreateQueueRequest

Includes:

Structure

Defined in:

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:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:description]

Instance Attribute Summary

• #allowed_storage_profile_ids ⇒ Array<String>

  The storage profile IDs to include in the queue.

• #client_token ⇒ String

  The unique token which the server uses to recognize retries of the same request.

• #default_budget_action ⇒ String

  The default action to take on a queue if a budget isn’t configured.

• #description ⇒ String

  The description of the queue.

• #display_name ⇒ String

  The display name of the queue.

• #farm_id ⇒ String

  The farm ID of the farm to connect to the queue.

• #job_attachment_settings ⇒ Types::JobAttachmentSettings

  The job attachment settings for the queue.

• #job_run_as_user ⇒ Types::JobRunAsUser

  The jobs in the queue run as the specified POSIX user.

• #required_file_system_location_names ⇒ Array<String>

  The file system location name to include in the queue.

• #role_arn ⇒ String

  The IAM role ARN that workers will use while running jobs for this queue.

• #scheduling_configuration ⇒ Types::SchedulingConfiguration

  The scheduling configuration for the queue.

• #tags ⇒ Hash<String,String>

  Each tag consists of a tag key and a tag value.

Instance Attribute Details

#allowed_storage_profile_ids ⇒ Array<String>

The storage profile IDs to include in the queue.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-deadline/types.rb', line 3260

class CreateQueueRequest < Struct.new(
  :farm_id,
  :client_token,
  :display_name,
  :description,
  :default_budget_action,
  :job_attachment_settings,
  :role_arn,
  :job_run_as_user,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :tags,
  :scheduling_configuration)
  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)

# File 'lib/aws-sdk-deadline/types.rb', line 3260

class CreateQueueRequest < Struct.new(
  :farm_id,
  :client_token,
  :display_name,
  :description,
  :default_budget_action,
  :job_attachment_settings,
  :role_arn,
  :job_run_as_user,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :tags,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#default_budget_action ⇒ String

The default action to take on a queue if a budget isn’t configured.

Returns:

• (String)

# File 'lib/aws-sdk-deadline/types.rb', line 3260

class CreateQueueRequest < Struct.new(
  :farm_id,
  :client_token,
  :display_name,
  :description,
  :default_budget_action,
  :job_attachment_settings,
  :role_arn,
  :job_run_as_user,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :tags,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

The description of the queue.

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)

# File 'lib/aws-sdk-deadline/types.rb', line 3260

class CreateQueueRequest < Struct.new(
  :farm_id,
  :client_token,
  :display_name,
  :description,
  :default_budget_action,
  :job_attachment_settings,
  :role_arn,
  :job_run_as_user,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :tags,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#display_name ⇒ String

The display name of the queue.

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)

# File 'lib/aws-sdk-deadline/types.rb', line 3260

class CreateQueueRequest < Struct.new(
  :farm_id,
  :client_token,
  :display_name,
  :description,
  :default_budget_action,
  :job_attachment_settings,
  :role_arn,
  :job_run_as_user,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :tags,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#farm_id ⇒ String

The farm ID of the farm to connect to the queue.

Returns:

• (String)

# File 'lib/aws-sdk-deadline/types.rb', line 3260

class CreateQueueRequest < Struct.new(
  :farm_id,
  :client_token,
  :display_name,
  :description,
  :default_budget_action,
  :job_attachment_settings,
  :role_arn,
  :job_run_as_user,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :tags,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#job_attachment_settings ⇒ Types::JobAttachmentSettings

The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

Returns:

• (Types::JobAttachmentSettings)

# File 'lib/aws-sdk-deadline/types.rb', line 3260

class CreateQueueRequest < Struct.new(
  :farm_id,
  :client_token,
  :display_name,
  :description,
  :default_budget_action,
  :job_attachment_settings,
  :role_arn,
  :job_run_as_user,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :tags,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#job_run_as_user ⇒ Types::JobRunAsUser

The jobs in the queue run as the specified POSIX user.

Returns:

• (Types::JobRunAsUser)

# File 'lib/aws-sdk-deadline/types.rb', line 3260

class CreateQueueRequest < Struct.new(
  :farm_id,
  :client_token,
  :display_name,
  :description,
  :default_budget_action,
  :job_attachment_settings,
  :role_arn,
  :job_run_as_user,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :tags,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#required_file_system_location_names ⇒ Array<String>

The file system location name to include in the queue.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-deadline/types.rb', line 3260

class CreateQueueRequest < Struct.new(
  :farm_id,
  :client_token,
  :display_name,
  :description,
  :default_budget_action,
  :job_attachment_settings,
  :role_arn,
  :job_run_as_user,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :tags,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#role_arn ⇒ String

The IAM role ARN that workers will use while running jobs for this queue.

Returns:

• (String)

# File 'lib/aws-sdk-deadline/types.rb', line 3260

class CreateQueueRequest < Struct.new(
  :farm_id,
  :client_token,
  :display_name,
  :description,
  :default_budget_action,
  :job_attachment_settings,
  :role_arn,
  :job_run_as_user,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :tags,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#scheduling_configuration ⇒ Types::SchedulingConfiguration

The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.

If not specified, the queue defaults to the ‘priorityFifo` scheduling configuration.

Returns:

• (Types::SchedulingConfiguration)

# File 'lib/aws-sdk-deadline/types.rb', line 3260

class CreateQueueRequest < Struct.new(
  :farm_id,
  :client_token,
  :display_name,
  :description,
  :default_budget_action,
  :job_attachment_settings,
  :role_arn,
  :job_run_as_user,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :tags,
  :scheduling_configuration)
  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>)

# File 'lib/aws-sdk-deadline/types.rb', line 3260

class CreateQueueRequest < Struct.new(
  :farm_id,
  :client_token,
  :display_name,
  :description,
  :default_budget_action,
  :job_attachment_settings,
  :role_arn,
  :job_run_as_user,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :tags,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end