Package software.amazon.awscdk.services.mediaconvert

Class CfnJobTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.mediaconvert.CfnJobTemplate
All Implemented Interfaces:
IInspectable, ITaggable, IJobTemplateRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:43.392Z") @Stability(Stable) public class CfnJobTemplate extends CfnResource implements IInspectable, IJobTemplateRef, ITaggable
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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnJobTemplate

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

    • CfnJobTemplate

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

    • CfnJobTemplate

      @Stability(Stable) public CfnJobTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnJobTemplateProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the job template, such as arn:aws:mediaconvert:us-west-2:123456789012 .

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      The name of the job template, such as Streaming stack DASH .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getJobTemplateRef

      @Stability(Stable) @NotNull public JobTemplateReference getJobTemplateRef()
      A reference to a JobTemplate resource.
      Specified by:
      getJobTemplateRef in interface IJobTemplateRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getSettingsJson

      @Stability(Stable) @NotNull public Object getSettingsJson()
      Specify, in JSON format, the transcoding job settings for this job template.

    • setSettingsJson

      @Stability(Stable) public void setSettingsJson(@NotNull Object value)
      Specify, in JSON format, the transcoding job settings for this job template.

    • getAccelerationSettings

      @Stability(Stable) @Nullable public Object getAccelerationSettings()
      Accelerated transcoding can significantly speed up jobs with long, visually complex content.

      Returns union: either IResolvable or CfnJobTemplate.AccelerationSettingsProperty

    • setAccelerationSettings

      @Stability(Stable) public void setAccelerationSettings(@Nullable IResolvable value)
      Accelerated transcoding can significantly speed up jobs with long, visually complex content.

    • setAccelerationSettings

      @Stability(Stable) public void setAccelerationSettings(@Nullable CfnJobTemplate.AccelerationSettingsProperty value)
      Accelerated transcoding can significantly speed up jobs with long, visually complex content.

    • getCategory

      @Stability(Stable) @Nullable public String getCategory()
      Optional.

    • setCategory

      @Stability(Stable) public void setCategory(@Nullable String value)
      Optional.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      Optional.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      Optional.

    • getHopDestinations

      @Stability(Stable) @Nullable public Object getHopDestinations()
      Optional.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnJobTemplate.HopDestinationProperty>

    • setHopDestinations

      @Stability(Stable) public void setHopDestinations(@Nullable IResolvable value)
      Optional.

    • setHopDestinations

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

    • getName

      @Stability(Stable) @Nullable public String getName()
      Name of the output group.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      Name of the output group.

    • getPriority

      @Stability(Stable) @Nullable public Number getPriority()
      Specify the relative priority for this job.

    • setPriority

      @Stability(Stable) public void setPriority(@Nullable Number value)
      Specify the relative priority for this job.

    • getQueue

      @Stability(Stable) @Nullable public String getQueue()
      Optional.

    • setQueue

      @Stability(Stable) public void setQueue(@Nullable String value)
      Optional.

    • getStatusUpdateInterval

      @Stability(Stable) @Nullable public String getStatusUpdateInterval()
      Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.

    • setStatusUpdateInterval

      @Stability(Stable) public void setStatusUpdateInterval(@Nullable String value)
      Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.

    • getTagsRaw

      @Stability(Stable) @Nullable public Object getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Object value)
      An array of key-value pairs to apply to this resource.