Class CfnJobTemplate
The AWS::MediaConvert::JobTemplate resource is an AWS Elemental MediaConvert resource type that you can use to generate transcoding jobs.
Inherited Members
Namespace: Amazon.CDK.AWS.MediaConvert
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnJobTemplate : CfnResource, IInspectable, IJobTemplateRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnJobTemplate Inherits CfnResource Implements IInspectable, IJobTemplateRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks
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) | The AWS::MediaConvert::JobTemplate resource is an AWS Elemental MediaConvert resource type that you can use to generate transcoding jobs. |
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 |
| AttrId | The AWS::MediaConvert::JobTemplate resource is an AWS Elemental MediaConvert resource type that you can use to generate transcoding jobs. |
| AttrName | The name of the job template, such as |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| Category | Optional. |
| CfnProperties | The AWS::MediaConvert::JobTemplate resource is an AWS Elemental MediaConvert resource type that you can use to generate transcoding jobs. |
| Description | Optional. |
| HopDestinations | Optional. |
| JobTemplateRef | A reference to a JobTemplate resource. |
| Name | Name of the output group. |
| 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 | Tag Manager which manages the tags for this resource. |
| TagsRaw | 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>) | The AWS::MediaConvert::JobTemplate resource is an AWS Elemental MediaConvert resource type that you can use to generate transcoding jobs. |
Constructors
CfnJobTemplate(Construct, string, ICfnJobTemplateProps)
The AWS::MediaConvert::JobTemplate resource is an AWS Elemental MediaConvert resource type that you can use to generate transcoding jobs.
public CfnJobTemplate(Construct scope, string id, ICfnJobTemplateProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnJobTemplateProps
Resource properties.
Remarks
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
Properties
AccelerationSettings
Accelerated transcoding can significantly speed up jobs with long, visually complex content.
public virtual object? AccelerationSettings { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnJobTemplate.IAccelerationSettingsProperty
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
Remarks
CloudformationAttribute: Arn
AttrId
The AWS::MediaConvert::JobTemplate resource is an AWS Elemental MediaConvert resource type that you can use to generate transcoding jobs.
public virtual string AttrId { get; }
Property Value
Remarks
CloudformationAttribute: Id
AttrName
The name of the job template, such as Streaming stack DASH .
public virtual string AttrName { get; }
Property Value
Remarks
CloudformationAttribute: Name
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
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
Category
Optional.
public virtual string? Category { get; set; }
Property Value
Remarks
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
CfnProperties
The AWS::MediaConvert::JobTemplate resource is an AWS Elemental MediaConvert resource type that you can use to generate transcoding jobs.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
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
Description
Optional.
public virtual string? Description { get; set; }
Property Value
Remarks
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
HopDestinations
Optional.
public virtual object? HopDestinations { get; set; }
Property Value
Remarks
Type union: either IResolvable or (either IResolvable or CfnJobTemplate.IHopDestinationProperty)[]
JobTemplateRef
A reference to a JobTemplate resource.
public virtual IJobTemplateReference JobTemplateRef { get; }
Property Value
Remarks
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
Name
Name of the output group.
public virtual string? Name { get; set; }
Property Value
Remarks
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
Priority
Specify the relative priority for this job.
public virtual double? Priority { get; set; }
Property Value
Remarks
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
Queue
Optional.
public virtual string? Queue { get; set; }
Property Value
Remarks
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
SettingsJson
Specify, in JSON format, the transcoding job settings for this job template.
public virtual object SettingsJson { get; set; }
Property Value
Remarks
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
StatusUpdateInterval
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
public virtual string? StatusUpdateInterval { get; set; }
Property Value
Remarks
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
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
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
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual object? TagsRaw { get; set; }
Property Value
Remarks
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
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.
Remarks
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
RenderProperties(IDictionary<string, object>)
The AWS::MediaConvert::JobTemplate resource is an AWS Elemental MediaConvert resource type that you can use to generate transcoding jobs.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
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