aws-cdk-lib.aws_mediaconvert.CfnJobTemplate

class CfnJobTemplate (construct)

LanguageType name
.NETAmazon.CDK.AWS.MediaConvert.CfnJobTemplate
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsmediaconvert#CfnJobTemplate
Javasoftware.amazon.awscdk.services.mediaconvert.CfnJobTemplate
Pythonaws_cdk.aws_mediaconvert.CfnJobTemplate
TypeScript aws-cdk-lib » aws_mediaconvert » CfnJobTemplate

Implements IConstruct, IDependable, 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 { aws_mediaconvert as mediaconvert } from 'aws-cdk-lib';

declare const settingsJson: any;
declare const tags: any;
const cfnJobTemplate = new mediaconvert.CfnJobTemplate(this, 'MyCfnJobTemplate', {
  settingsJson: settingsJson,

  // the properties below are optional
  accelerationSettings: {
    mode: 'mode',
  },
  category: 'category',
  description: 'description',
  hopDestinations: [{
    priority: 123,
    queue: 'queue',
    waitMinutes: 123,
  }],
  name: 'name',
  priority: 123,
  queue: 'queue',
  statusUpdateInterval: 'statusUpdateInterval',
  tags: tags,
});

Initializer

new CfnJobTemplate(scope: Construct, id: string, props: CfnJobTemplateProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnJobTemplateProps — - resource properties.

Create a new AWS::MediaConvert::JobTemplate.

Construct Props

NameTypeDescription
settingsJsonanySpecify, in JSON format, the transcoding job settings for this job template.
accelerationSettings?IResolvable | AccelerationSettingsPropertyAccelerated transcoding can significantly speed up jobs with long, visually complex content.
category?stringOptional.
description?stringOptional.
hopDestinations?IResolvable | IResolvable | HopDestinationProperty[]Optional.
name?stringThe name of the job template you are creating.
priority?numberSpecify the relative priority for this job.
queue?stringOptional.
statusUpdateInterval?stringSpecify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
tags?anyAn array of key-value pairs to apply to this resource.

settingsJson

Type: any

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


accelerationSettings?

Type: IResolvable | AccelerationSettingsProperty (optional)

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 .


category?

Type: string (optional)

Optional.

A category for the job template you are creating


description?

Type: string (optional)

Optional.

A description of the job template you are creating.


hopDestinations?

Type: IResolvable | IResolvable | HopDestinationProperty[] (optional)

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 .


name?

Type: string (optional)

The name of the job template you are creating.


priority?

Type: number (optional)

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


queue?

Type: string (optional)

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.


statusUpdateInterval?

Type: string (optional)

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


tags?

Type: any (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Properties

NameTypeDescription
attrArnstringThe Amazon Resource Name (ARN) of the job template, such as arn:aws:mediaconvert:us-west-2:123456789012 .
attrNamestringThe name of the job template, such as Streaming stack DASH .
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
settingsJsonanySpecify, in JSON format, the transcoding job settings for this job template.
stackStackThe stack in which this element is defined.
tagsTagManagerAn array of key-value pairs to apply to this resource.
accelerationSettings?IResolvable | AccelerationSettingsPropertyAccelerated transcoding can significantly speed up jobs with long, visually complex content.
category?stringOptional.
description?stringOptional.
hopDestinations?IResolvable | IResolvable | HopDestinationProperty[]Optional.
name?stringThe name of the job template you are creating.
priority?numberSpecify the relative priority for this job.
queue?stringOptional.
statusUpdateInterval?stringSpecify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrArn

Type: string

The Amazon Resource Name (ARN) of the job template, such as arn:aws:mediaconvert:us-west-2:123456789012 .


attrName

Type: string

The name of the job template, such as Streaming stack DASH .


cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.


cfnProperties

Type: { [string]: any }


cfnResourceType

Type: string

AWS resource type.


creationStack

Type: string[]


logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


node

Type: Node

The tree node.


ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


settingsJson

Type: any

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


stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).


tags

Type: TagManager

An array of key-value pairs to apply to this resource.

For more information, see Tag .


accelerationSettings?

Type: IResolvable | AccelerationSettingsProperty (optional)

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 .


category?

Type: string (optional)

Optional.

A category for the job template you are creating


description?

Type: string (optional)

Optional.

A description of the job template you are creating.


hopDestinations?

Type: IResolvable | IResolvable | HopDestinationProperty[] (optional)

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 .


name?

Type: string (optional)

The name of the job template you are creating.


priority?

Type: number (optional)

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


queue?

Type: string (optional)

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.


statusUpdateInterval?

Type: string (optional)

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


static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).


addDependency(target)

public addDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.


addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.


addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.


addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).


applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

  • policy RemovalPolicy
  • options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

Returns

  • Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.


getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }