Package 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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.899Z") @Stability(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();

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

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getSettingsJson

      @Stability(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(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(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(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(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(Stable) @Nullable public String getCategory()
      Optional.

      A category for the job template you are creating

    • setCategory

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

      A category for the job template you are creating

    • getDescription

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

      A description of the job template you are creating.

    • setDescription

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

      A description of the job template you are creating.

    • getHopDestinations

      @Stability(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(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(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(Stable) @Nullable public String getName()
      The name of the job template you are creating.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the job template you are creating.

    • getPriority

      @Stability(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(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(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(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(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(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