Class: AWSCDK::MediaConvert::CfnQueueProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_convert/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(concurrent_jobs: nil, description: nil, maximum_concurrent_feeds: nil, name: nil, pricing_plan: nil, status: nil, tags: nil) ⇒ CfnQueueProps

Returns a new instance of CfnQueueProps.

Parameters:

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

    Specify the maximum number of jobs your queue can process concurrently.

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

    Optional.

  • maximum_concurrent_feeds (Numeric, nil) (defaults to: nil)
  • name (String, nil) (defaults to: nil) —

    The name of the queue that you are creating.

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

    When you use CloudFormation , you can create only on-demand queues.

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

    Initial state of the queue.

  • tags (Object, nil) (defaults to: nil) —

    An array of key-value pairs to apply to this resource.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'media_convert/cfn_queue_props.rb', line 16

def initialize(concurrent_jobs: nil, description: nil, maximum_concurrent_feeds: nil, name: nil, pricing_plan: nil, status: nil, tags: nil)
  @concurrent_jobs = concurrent_jobs
  Jsii::Type.check_type(@concurrent_jobs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "concurrentJobs") unless @concurrent_jobs.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @maximum_concurrent_feeds = maximum_concurrent_feeds
  Jsii::Type.check_type(@maximum_concurrent_feeds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumConcurrentFeeds") unless @maximum_concurrent_feeds.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @pricing_plan = pricing_plan
  Jsii::Type.check_type(@pricing_plan, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pricingPlan") unless @pricing_plan.nil?
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tags") unless @tags.nil?
end

Instance Attribute Details

#concurrent_jobs ⇒ Numeric? (readonly)

Specify the maximum number of jobs your queue can process concurrently.

For on-demand queues, the value you enter is constrained by your service quotas for Maximum concurrent jobs, per on-demand queue and Maximum concurrent jobs, per account. For reserved queues, specify the number of jobs you can process concurrently in your reservation plan instead.

Returns:

  • (Numeric, nil)

See Also:



39
40
41
 
# File 'media_convert/cfn_queue_props.rb', line 39

def concurrent_jobs
  @concurrent_jobs
end

#description ⇒ String? (readonly)

Optional.

A description of the queue that you are creating.

Returns:

  • (String, nil)

See Also:



46
47
48
 
# File 'media_convert/cfn_queue_props.rb', line 46

def description
  @description
end

#maximum_concurrent_feeds ⇒ Numeric? (readonly)

Returns:

  • (Numeric, nil)

See Also:



49
50
51
 
# File 'media_convert/cfn_queue_props.rb', line 49

def maximum_concurrent_feeds
  @maximum_concurrent_feeds
end

#name ⇒ String? (readonly)

The name of the queue that you are creating.

Returns:

  • (String, nil)

See Also:



54
55
56
 
# File 'media_convert/cfn_queue_props.rb', line 54

def name
  @name
end

#pricing_plan ⇒ String? (readonly)

When you use CloudFormation , you can create only on-demand queues.

Therefore, always set PricingPlan to the value "ON_DEMAND" when declaring an AWS::MediaConvert::Queue in your CloudFormation template.

To create a reserved queue, use the AWS Elemental MediaConvert console at https://console.aws.amazon.com/mediaconvert to set up a contract. For more information, see Working with AWS Elemental MediaConvert Queues in the ** .

Returns:

  • (String, nil)

See Also:



63
64
65
 
# File 'media_convert/cfn_queue_props.rb', line 63

def pricing_plan
  @pricing_plan
end

#status ⇒ String? (readonly)

Initial state of the queue.

Queues can be either ACTIVE or PAUSED. If you create a paused queue, then jobs that you send to that queue won't begin.

Returns:

  • (String, nil)

See Also:



70
71
72
 
# File 'media_convert/cfn_queue_props.rb', line 70

def status
  @status
end

#tags ⇒ Object? (readonly)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Returns:

  • (Object, nil)

See Also:



77
78
79
 
# File 'media_convert/cfn_queue_props.rb', line 77

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
 
# File 'media_convert/cfn_queue_props.rb', line 79

def self.jsii_properties
  {
    :concurrent_jobs => "concurrentJobs",
    :description => "description",
    :maximum_concurrent_feeds => "maximumConcurrentFeeds",
    :name => "name",
    :pricing_plan => "pricingPlan",
    :status => "status",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'media_convert/cfn_queue_props.rb', line 91

def to_jsii
  result = {}
  result.merge!({
    "concurrentJobs" => @concurrent_jobs,
    "description" => @description,
    "maximumConcurrentFeeds" => @maximum_concurrent_feeds,
    "name" => @name,
    "pricingPlan" => @pricing_plan,
    "status" => @status,
    "tags" => @tags,
  })
  result.compact
end