interface CfnJobTemplateProps

This page is available in another version. Click here for the v2 documentation.

Language	Type name
.NET	Amazon.CDK.AWS.MediaConvert.CfnJobTemplateProps
Java	software.amazon.awscdk.services.mediaconvert.CfnJobTemplateProps
Python	aws_cdk.aws_mediaconvert.CfnJobTemplateProps
TypeScript	@aws-cdk/aws-mediaconvert » CfnJobTemplateProps

Properties for defining a CfnJobTemplate.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as mediaconvert from '@aws-cdk/aws-mediaconvert';

declare const settingsJson: any;
declare const tags: any;
const cfnJobTemplateProps: mediaconvert.CfnJobTemplateProps = {
  settingsJson: settingsJson,

  // the properties below are optional
  accelerationSettings: {
    mode: 'mode',
  },
  category: 'category',
  description: 'description',
  hopDestinations: [{
    priority: 123,
    queue: 'queue',
    waitMinutes: 123,
  }],
  name: 'name',
  priority: 123,
  queue: 'queue',
  statusUpdateInterval: 'statusUpdateInterval',
  tags: tags,
};

Properties

Name	Type	Description
settingsJson	any	Specify, in JSON format, the transcoding job settings for this job template.
accelerationSettings?	IResolvable | AccelerationSettingsProperty	Accelerated transcoding can significantly speed up jobs with long, visually complex content.
category?	string	Optional.
description?	string	Optional.
hopDestinations?	IResolvable | IResolvable | HopDestinationProperty[]	Optional.
name?	string	The name of the job template you are creating.
priority?	number	Specify the relative priority for this job.
queue?	string	Optional.
statusUpdateInterval?	string	Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
tags?	any	An array of key-value pairs to apply to this resource.

---

settingsJson

Type: any

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 ** .

---

accelerationSettings?

Type: IResolvable | AccelerationSettingsProperty (optional)

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 .

---

category?

Type: string (optional)

Optional.

A category for the job template you are creating

---

description?

Type: string (optional)

Optional.

A description of the job template you are creating.

---

hopDestinations?

Type: IResolvable | IResolvable | HopDestinationProperty[] (optional)

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 .

---

name?

Type: string (optional)

The name of the job template you are creating.

---

priority?

Type: number (optional)

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

---

queue?

Type: string (optional)

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.

---

statusUpdateInterval?

Type: string (optional)

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

---

tags?

Type: any (optional)

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

For more information, see Tag .