software.amazon.awscdk.services.mediaconvert

Class CfnJobTemplate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.mediaconvert.CfnJobTemplate

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.978Z")
 @Stability(value=Stable)
public class CfnJobTemplate
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MediaConvert::JobTemplate`.

The AWS::MediaConvert::JobTemplate resource is an AWS Elemental MediaConvert resource type that you can use to generate transcoding jobs.

When you declare this entity in your AWS CloudFormation template, you pass in your transcoding job settings in JSON or YAML format. This settings specification must be formed in a particular way that conforms to AWS Elemental MediaConvert job validation. For more information about creating a job template model for the SettingsJson property, see the Remarks section later in this topic.

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

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;
 CfnJobTemplate cfnJobTemplate = CfnJobTemplate.Builder.create(this, "MyCfnJobTemplate")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnJobTemplate.AccelerationSettingsProperty Accelerated transcoding can significantly speed up jobs with long, visually complex content.
static class	CfnJobTemplate.Builder A fluent builder for CfnJobTemplate.
static interface	CfnJobTemplate.HopDestinationProperty Optional.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnJobTemplate(Construct scope, String id, CfnJobTemplateProps props) Create a new `AWS::MediaConvert::JobTemplate`.
protected	CfnJobTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnJobTemplate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAccelerationSettings() Accelerated transcoding can significantly speed up jobs with long, visually complex content.
String	getAttrArn() The Amazon Resource Name (ARN) of the job template, such as `arn:aws:mediaconvert:us-west-2:123456789012` .
String	getAttrName() The name of the job template, such as `Streaming stack DASH` .
String	getCategory() Optional.
protected Map<String,Object>	getCfnProperties()
String	getDescription() Optional.
Object	getHopDestinations() Optional.
String	getName() The name of the job template you are creating.
Number	getPriority() Specify the relative priority for this job.
String	getQueue() Optional.
Object	getSettingsJson() Specify, in JSON format, the transcoding job settings for this job template.
String	getStatusUpdateInterval() Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccelerationSettings(CfnJobTemplate.AccelerationSettingsProperty value) Accelerated transcoding can significantly speed up jobs with long, visually complex content.
void	setAccelerationSettings(IResolvable value) Accelerated transcoding can significantly speed up jobs with long, visually complex content.
void	setCategory(String value) Optional.
void	setDescription(String value) Optional.
void	setHopDestinations(IResolvable value) Optional.
void	setHopDestinations(List<Object> value) Optional.
void	setName(String value) The name of the job template you are creating.
void	setPriority(Number value) Specify the relative priority for this job.
void	setQueue(String value) Optional.
void	setSettingsJson(Object value) Specify, in JSON format, the transcoding job settings for this job template.
void	setStatusUpdateInterval(String value) Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnJobTemplate

protected CfnJobTemplate(software.amazon.jsii.JsiiObjectRef objRef)

CfnJobTemplate

protected CfnJobTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnJobTemplate

@Stability(value=Stable)
public CfnJobTemplate(@NotNull
                                               Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnJobTemplateProps props)

Create a new `AWS::MediaConvert::JobTemplate`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the job template, such as `arn:aws:mediaconvert:us-west-2:123456789012` .

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

The name of the job template, such as `Streaming stack DASH` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getSettingsJson

@Stability(value=Stable)
 @NotNull
public 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 ** .

setSettingsJson

@Stability(value=Stable)
public void setSettingsJson(@NotNull
                                                     Object value)

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

getAccelerationSettings

@Stability(value=Stable)
 @Nullable
public 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 .

setAccelerationSettings

@Stability(value=Stable)
public void setAccelerationSettings(@Nullable
                                                             IResolvable value)

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 .

setAccelerationSettings

@Stability(value=Stable)
public void setAccelerationSettings(@Nullable
                                                             CfnJobTemplate.AccelerationSettingsProperty value)

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 .

getCategory

@Stability(value=Stable)
 @Nullable
public String getCategory()

Optional.

A category for the job template you are creating

setCategory

@Stability(value=Stable)
public void setCategory(@Nullable
                                                 String value)

Optional.

A category for the job template you are creating

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

Optional.

A description of the job template you are creating.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

Optional.

A description of the job template you are creating.

getHopDestinations

@Stability(value=Stable)
 @Nullable
public 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 .

setHopDestinations

@Stability(value=Stable)
public void setHopDestinations(@Nullable
                                                        IResolvable value)

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 .

setHopDestinations

@Stability(value=Stable)
public void setHopDestinations(@Nullable
                                                        List<Object> value)

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 .

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the job template you are creating.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the job template you are creating.

getPriority

@Stability(value=Stable)
 @Nullable
public 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

setPriority

@Stability(value=Stable)
public void setPriority(@Nullable
                                                 Number value)

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

getQueue

@Stability(value=Stable)
 @Nullable
public 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.

setQueue

@Stability(value=Stable)
public void setQueue(@Nullable
                                              String value)

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.

getStatusUpdateInterval

@Stability(value=Stable)
 @Nullable
public 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

setStatusUpdateInterval

@Stability(value=Stable)
public void setStatusUpdateInterval(@Nullable
                                                             String value)

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