Interface CfnJobTemplateProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnJobTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.917Z") @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();
 
  • 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 ** .

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

    • getCategory

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

      A category for the job template you are creating

    • getDescription

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

      A description of the job template you are creating.

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

    • getName

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

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

    • 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

    • getTags

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

      For more information, see Tag .

    • builder

      @Stability(Stable) static CfnJobTemplateProps.Builder builder()
      Returns:
      a CfnJobTemplateProps.Builder of CfnJobTemplateProps