Class: AWSCDK::MediaConvert::CfnJobTemplate::HopDestinationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_convert/cfn_job_template.rb

Overview

Optional.

Configuration for a destination queue to which the job can hop once a customer-defined minimum wait time has passed. For more information, see Setting Up Queue Hopping to Avoid Long Waits in the AWS Elemental MediaConvert User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(priority: nil, queue: nil, wait_minutes: nil) ⇒ HopDestinationProperty

Returns a new instance of HopDestinationProperty.

Parameters:

  • priority (Numeric, nil) (defaults to: nil) —

    Optional.

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

    Optional unless the job is submitted on the default queue.

  • wait_minutes (Numeric, nil) (defaults to: nil) —

    Required for setting up a job to use queue hopping.



717
718
719
720
721
722
723
724
 
# File 'media_convert/cfn_job_template.rb', line 717

def initialize(priority: nil, queue: nil, wait_minutes: nil)
  @priority = priority
  Jsii::Type.check_type(@priority, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "priority") unless @priority.nil?
  @queue = queue
  Jsii::Type.check_type(@queue, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queue") unless @queue.nil?
  @wait_minutes = wait_minutes
  Jsii::Type.check_type(@wait_minutes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "waitMinutes") unless @wait_minutes.nil?
end

Instance Attribute Details

#priority ⇒ Numeric? (readonly)

Optional.

When you set up a job to use queue hopping, you can specify a different relative priority for the job in the destination queue. If you don't specify, the relative priority will remain the same as in the previous queue.

Returns:

  • (Numeric, nil)

See Also:



732
733
734
 
# File 'media_convert/cfn_job_template.rb', line 732

def priority
  @priority
end

#queue ⇒ String? (readonly)

Optional unless the job is submitted on the default queue.

When you set up a job to use queue hopping, you can specify a destination queue. This queue cannot be the original queue to which the job is submitted. If the original queue isn't the default queue and you don't specify the destination queue, the job will move to the default queue.

Returns:

  • (String, nil)

See Also:



739
740
741
 
# File 'media_convert/cfn_job_template.rb', line 739

def queue
  @queue
end

#wait_minutes ⇒ Numeric? (readonly)

Required for setting up a job to use queue hopping.

Minimum wait time in minutes until the job can hop to the destination queue. Valid range is 1 to 4320 minutes, inclusive.

Returns:

  • (Numeric, nil)

See Also:



746
747
748
 
# File 'media_convert/cfn_job_template.rb', line 746

def wait_minutes
  @wait_minutes
end

Class Method Details

.jsii_properties ⇒ Object 



748
749
750
751
752
753
754
 
# File 'media_convert/cfn_job_template.rb', line 748

def self.jsii_properties
  {
    :priority => "priority",
    :queue => "queue",
    :wait_minutes => "waitMinutes",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



756
757
758
759
760
761
762
763
764
 
# File 'media_convert/cfn_job_template.rb', line 756

def to_jsii
  result = {}
  result.merge!({
    "priority" => @priority,
    "queue" => @queue,
    "waitMinutes" => @wait_minutes,
  })
  result.compact
end