Class: AWSCDK::MediaConvert::CfnJobTemplateProps

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

Overview

Properties for defining a CfnJobTemplate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(settings_json:, acceleration_settings: nil, category: nil, description: nil, hop_destinations: nil, name: nil, priority: nil, queue: nil, status_update_interval: nil, tags: nil) ⇒ CfnJobTemplateProps

Returns a new instance of CfnJobTemplateProps.

Parameters:

  • settings_json (Object) —

    Specify, in JSON format, the transcoding job settings for this job template.

  • acceleration_settings (AWSCDK::IResolvable, AWSCDK::MediaConvert::CfnJobTemplate::AccelerationSettingsProperty, nil) (defaults to: nil) —

    Accelerated transcoding can significantly speed up jobs with long, visually complex content.

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

    Optional.

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

    Optional.

  • hop_destinations (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::MediaConvert::CfnJobTemplate::HopDestinationProperty>, nil) (defaults to: nil) —

    Optional.

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

    Name of the output group.

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

    Specify the relative priority for this job.

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

    Optional.

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

    Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.

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

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



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'media_convert/cfn_job_template_props.rb', line 19

def initialize(settings_json:, acceleration_settings: nil, category: nil, description: nil, hop_destinations: nil, name: nil, priority: nil, queue: nil, status_update_interval: nil, tags: nil)
  @settings_json = settings_json
  Jsii::Type.check_type(@settings_json, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "settingsJson")
  @acceleration_settings = acceleration_settings.is_a?(Hash) ? ::AWSCDK::MediaConvert::CfnJobTemplate::AccelerationSettingsProperty.new(**acceleration_settings.transform_keys(&:to_sym)) : acceleration_settings
  Jsii::Type.check_type(@acceleration_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbnZlcnQuQ2ZuSm9iVGVtcGxhdGUuQWNjZWxlcmF0aW9uU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "accelerationSettings") unless @acceleration_settings.nil?
  @category = category
  Jsii::Type.check_type(@category, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "category") unless @category.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @hop_destinations = hop_destinations
  Jsii::Type.check_type(@hop_destinations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFjb252ZXJ0LkNmbkpvYlRlbXBsYXRlLkhvcERlc3RpbmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "hopDestinations") unless @hop_destinations.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.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?
  @status_update_interval = status_update_interval
  Jsii::Type.check_type(@status_update_interval, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "statusUpdateInterval") unless @status_update_interval.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tags") unless @tags.nil?
end

Instance Attribute Details

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

Accelerated transcoding can significantly speed up jobs with long, visually complex content.

Outputs that use this feature incur pro-tier pricing. For information about feature limitations, For more information, see Job Limitations for Accelerated Transcoding in AWS Elemental MediaConvert in the AWS Elemental MediaConvert User Guide .

Returns:

See Also:



57
58
59
 
# File 'media_convert/cfn_job_template_props.rb', line 57

def acceleration_settings
  @acceleration_settings
end

#category ⇒ String? (readonly)

Optional.

A category for the job template you are creating

Returns:

  • (String, nil)

See Also:



64
65
66
 
# File 'media_convert/cfn_job_template_props.rb', line 64

def category
  @category
end

#description ⇒ String? (readonly)

Optional.

A description of the job template you are creating.

Returns:

  • (String, nil)

See Also:



71
72
73
 
# File 'media_convert/cfn_job_template_props.rb', line 71

def description
  @description
end

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

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 .

Returns:

See Also:



78
79
80
 
# File 'media_convert/cfn_job_template_props.rb', line 78

def hop_destinations
  @hop_destinations
end

#name ⇒ String? (readonly)

Name of the output group.

Returns:

  • (String, nil)

See Also:



83
84
85
 
# File 'media_convert/cfn_job_template_props.rb', line 83

def name
  @name
end

#priority ⇒ Numeric? (readonly)

Specify the relative priority for this job.

In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0. Minimum: -50 Maximum: 50

Returns:

  • (Numeric, nil)

See Also:



90
91
92
 
# File 'media_convert/cfn_job_template_props.rb', line 90

def priority
  @priority
end

#queue ⇒ String? (readonly)

Optional.

The queue that jobs created from this template are assigned to. Specify the Amazon Resource Name (ARN) of the queue. For example, arn:aws:mediaconvert:us-west-2:505474453218:queues/Default. If you don't specify this, jobs will go to the default queue.

Returns:

  • (String, nil)

See Also:



97
98
99
 
# File 'media_convert/cfn_job_template_props.rb', line 97

def queue
  @queue
end

#settings_json ⇒ Object (readonly)

Specify, in JSON format, the transcoding job settings for this job template.

This specification must conform to the AWS Elemental MediaConvert job validation. For information about forming this specification, see the Remarks section later in this topic.

For more information about MediaConvert job templates, see Working with AWS Elemental MediaConvert Job Templates in the ** .

Returns:

  • (Object)

See Also:



50
51
52
 
# File 'media_convert/cfn_job_template_props.rb', line 50

def settings_json
  @settings_json
end

#status_update_interval ⇒ String? (readonly)

Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.

Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.

Specify one of the following enums:

SECONDS_10

SECONDS_12

SECONDS_15

SECONDS_20

SECONDS_30

SECONDS_60

SECONDS_120

SECONDS_180

SECONDS_240

SECONDS_300

SECONDS_360

SECONDS_420

SECONDS_480

SECONDS_540

SECONDS_600

Returns:

  • (String, nil)

See Also:



136
137
138
 
# File 'media_convert/cfn_job_template_props.rb', line 136

def status_update_interval
  @status_update_interval
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:



143
144
145
 
# File 'media_convert/cfn_job_template_props.rb', line 143

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'media_convert/cfn_job_template_props.rb', line 145

def self.jsii_properties
  {
    :settings_json => "settingsJson",
    :acceleration_settings => "accelerationSettings",
    :category => "category",
    :description => "description",
    :hop_destinations => "hopDestinations",
    :name => "name",
    :priority => "priority",
    :queue => "queue",
    :status_update_interval => "statusUpdateInterval",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'media_convert/cfn_job_template_props.rb', line 160

def to_jsii
  result = {}
  result.merge!({
    "settingsJson" => @settings_json,
    "accelerationSettings" => @acceleration_settings,
    "category" => @category,
    "description" => @description,
    "hopDestinations" => @hop_destinations,
    "name" => @name,
    "priority" => @priority,
    "queue" => @queue,
    "statusUpdateInterval" => @status_update_interval,
    "tags" => @tags,
  })
  result.compact
end