Package software.amazon.awscdk.services.mediaconvert

Interface CfnJobTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:09.730Z")
@Stability(Stable)
public interface CfnJobTemplateProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.mediaconvert.*;
 Object settingsJson;
 Object tags;
 CfnJobTemplateProps cfnJobTemplateProps = CfnJobTemplateProps.builder()
         .settingsJson(settingsJson)
         // the properties below are optional
         .accelerationSettings(AccelerationSettingsProperty.builder()
                 .mode("mode")
                 .build())
         .category("category")
         .description("description")
         .hopDestinations(List.of(HopDestinationProperty.builder()
                 .priority(123)
                 .queue("queue")
                 .waitMinutes(123)
                 .build()))
         .name("name")
         .priority(123)
         .queue("queue")
         .statusUpdateInterval("statusUpdateInterval")
         .tags(tags)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnJobTemplateProps.Builder	A builder for CfnJobTemplateProps
static final class	CfnJobTemplateProps.Jsii$Proxy	An implementation for CfnJobTemplateProps

Method Summary

Modifier and Type	Method	Description
static CfnJobTemplateProps.Builder	builder()
default Object	getAccelerationSettings()	Accelerated transcoding can significantly speed up jobs with long, visually complex content.
default String	getCategory()	Optional.
default String	getDescription()	Optional.
default Object	getHopDestinations()	Optional.
default String	getName()	Name of the output group.
default Number	getPriority()	Specify the relative priority for this job.
default String	getQueue()	Optional.
Object	getSettingsJson()	Specify, in JSON format, the transcoding job settings for this job template.
default String	getStatusUpdateInterval()	Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
default Object	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSettingsJson

@Stability(Stable)
@NotNull
Object getSettingsJson()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-settingsjson

getAccelerationSettings

@Stability(Stable)
@Nullable
default Object getAccelerationSettings()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-accelerationsettings

getCategory

@Stability(Stable)
@Nullable
default String getCategory()

Optional.

A category for the job template you are creating

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-category

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Optional.

A description of the job template you are creating.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-description

getHopDestinations

@Stability(Stable)
@Nullable
default Object getHopDestinations()

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-hopdestinations

getName

@Stability(Stable)
@Nullable
default String getName()

Name of the output group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-name

getPriority

@Stability(Stable)
@Nullable
default Number getPriority()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-priority

getQueue

@Stability(Stable)
@Nullable
default String getQueue()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-queue

getStatusUpdateInterval

@Stability(Stable)
@Nullable
default String getStatusUpdateInterval()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-statusupdateinterval

getTags

@Stability(Stable)
@Nullable
default Object getTags()

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

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-tags

builder

@Stability(Stable)
static CfnJobTemplateProps.Builder builder()

Returns:

a CfnJobTemplateProps.Builder of CfnJobTemplateProps