You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MediaConvert::Types::CreateQueueRequest

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

Overview

Note:

When making an API call, you may pass CreateQueueRequest data as a hash:

{
  description: "__string",
  name: "__string", # required
  pricing_plan: "ON_DEMAND", # accepts ON_DEMAND, RESERVED
  reservation_plan_settings: {
    commitment: "ONE_YEAR", # required, accepts ONE_YEAR
    renewal_type: "AUTO_RENEW", # required, accepts AUTO_RENEW, EXPIRE
    reserved_slots: 1, # required
  },
  status: "ACTIVE", # accepts ACTIVE, PAUSED
  tags: {
    "__string" => "__string",
  },
}

Create an on-demand queue by sending a CreateQueue request with the name of the queue. Create a reserved queue by sending a CreateQueue request with the pricing plan set to RESERVED and with values specified for the settings under reservationPlanSettings. When you create a reserved queue, you enter into a 12-month commitment to purchase the RTS that you specify. You can't cancel this commitment.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

Optional. A description of the queue that you are creating.

Returns:

  • (String)


4721
4722
4723
4724
4725
4726
4727
4728
4729
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 4721

class CreateQueueRequest < Struct.new(
  :description,
  :name,
  :pricing_plan,
  :reservation_plan_settings,
  :status,
  :tags)
  include Aws::Structure
end

#nameString

The name of the queue that you are creating.

Returns:

  • (String)


4721
4722
4723
4724
4725
4726
4727
4728
4729
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 4721

class CreateQueueRequest < Struct.new(
  :description,
  :name,
  :pricing_plan,
  :reservation_plan_settings,
  :status,
  :tags)
  include Aws::Structure
end

#pricing_planString

Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. When you use the API to create a queue, the default is on-demand.

Returns:

  • (String)


4721
4722
4723
4724
4725
4726
4727
4728
4729
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 4721

class CreateQueueRequest < Struct.new(
  :description,
  :name,
  :pricing_plan,
  :reservation_plan_settings,
  :status,
  :tags)
  include Aws::Structure
end

#reservation_plan_settingsTypes::ReservationPlanSettings

Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.



4721
4722
4723
4724
4725
4726
4727
4728
4729
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 4721

class CreateQueueRequest < Struct.new(
  :description,
  :name,
  :pricing_plan,
  :reservation_plan_settings,
  :status,
  :tags)
  include Aws::Structure
end

#statusString

Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin.

Returns:

  • (String)


4721
4722
4723
4724
4725
4726
4727
4728
4729
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 4721

class CreateQueueRequest < Struct.new(
  :description,
  :name,
  :pricing_plan,
  :reservation_plan_settings,
  :status,
  :tags)
  include Aws::Structure
end

#tagsHash<String,String>

The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.

Returns:

  • (Hash<String,String>)


4721
4722
4723
4724
4725
4726
4727
4728
4729
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 4721

class CreateQueueRequest < Struct.new(
  :description,
  :name,
  :pricing_plan,
  :reservation_plan_settings,
  :status,
  :tags)
  include Aws::Structure
end