Class CfnJobTemplate
A CloudFormation AWS::MediaConvert::JobTemplate
.
Inherited Members
Namespace: Amazon.CDK.AWS.MediaConvert
Assembly: Amazon.CDK.AWS.MediaConvert.dll
Syntax (csharp)
public class CfnJobTemplate : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnJobTemplate
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 ** .
CloudformationResource: AWS::MediaConvert::JobTemplate
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaConvert;
var settingsJson;
var tags;
var cfnJobTemplate = new CfnJobTemplate(this, "MyCfnJobTemplate", new CfnJobTemplateProps {
SettingsJson = settingsJson,
// the properties below are optional
AccelerationSettings = new AccelerationSettingsProperty {
Mode = "mode"
},
Category = "category",
Description = "description",
HopDestinations = new [] { new HopDestinationProperty {
Priority = 123,
Queue = "queue",
WaitMinutes = 123
} },
Name = "name",
Priority = 123,
Queue = "queue",
StatusUpdateInterval = "statusUpdateInterval",
Tags = tags
});
Synopsis
Constructors
CfnJobTemplate(Construct, String, ICfnJobTemplateProps) | Create a new |
CfnJobTemplate(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnJobTemplate(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AccelerationSettings | Accelerated transcoding can significantly speed up jobs with long, visually complex content. |
AttrArn | The Amazon Resource Name (ARN) of the job template, such as |
AttrName | The name of the job template, such as |
Category | Optional. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | Optional. |
HopDestinations | Optional. |
Name | The name of the job template you are creating. |
Priority | Specify the relative priority for this job. |
Queue | Optional. |
SettingsJson | Specify, in JSON format, the transcoding job settings for this job template. |
StatusUpdateInterval | Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. |
Tags | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnJobTemplate(Construct, String, ICfnJobTemplateProps)
Create a new AWS::MediaConvert::JobTemplate
.
public CfnJobTemplate(Construct scope, string id, ICfnJobTemplateProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnJobTemplateProps
- resource properties.
CfnJobTemplate(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnJobTemplate(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnJobTemplate(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnJobTemplate(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AccelerationSettings
Accelerated transcoding can significantly speed up jobs with long, visually complex content.
public virtual object AccelerationSettings { get; set; }
Property Value
System.Object
Remarks
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 .
AttrArn
The Amazon Resource Name (ARN) of the job template, such as arn:aws:mediaconvert:us-west-2:123456789012
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrName
The name of the job template, such as Streaming stack DASH
.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
Category
Optional.
public virtual string Category { get; set; }
Property Value
System.String
Remarks
A category for the job template you are creating
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
Optional.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
A description of the job template you are creating.
HopDestinations
Optional.
public virtual object HopDestinations { get; set; }
Property Value
System.Object
Remarks
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 .
Name
The name of the job template you are creating.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Priority
Specify the relative priority for this job.
public virtual Nullable<double> Priority { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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
Queue
Optional.
public virtual string Queue { get; set; }
Property Value
System.String
Remarks
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.
SettingsJson
Specify, in JSON format, the transcoding job settings for this job template.
public virtual object SettingsJson { get; set; }
Property Value
System.Object
Remarks
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 ** .
StatusUpdateInterval
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
public virtual string StatusUpdateInterval { get; set; }
Property Value
System.String
Remarks
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
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>