CfnJobTemplate
- class aws_cdk.aws_mediaconvert.CfnJobTemplate(scope, id, *, settings_json, acceleration_settings=None, category=None, description=None, hop_destinations=None, name=None, priority=None, queue=None, status_update_interval=None, tags=None)
Bases:
CfnResourceA 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
SettingsJsonproperty, 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
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_mediaconvert as mediaconvert # settings_json: Any # tags: Any cfn_job_template = mediaconvert.CfnJobTemplate(self, "MyCfnJobTemplate", settings_json=settings_json, # the properties below are optional acceleration_settings=mediaconvert.CfnJobTemplate.AccelerationSettingsProperty( mode="mode" ), category="category", description="description", hop_destinations=[mediaconvert.CfnJobTemplate.HopDestinationProperty( priority=123, queue="queue", wait_minutes=123 )], name="name", priority=123, queue="queue", status_update_interval="statusUpdateInterval", tags=tags )
Create a new
AWS::MediaConvert::JobTemplate.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
settings_json (
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 ** .
acceleration_settings (
Union[IResolvable,AccelerationSettingsProperty,Dict[str,Any],None]) – 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 (
Optional[str]) – Optional. A category for the job template you are creatingdescription (
Optional[str]) – Optional. A description of the job template you are creating.hop_destinations (
Union[IResolvable,Sequence[Union[IResolvable,HopDestinationProperty,Dict[str,Any]]],None]) – 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 (
Optional[str]) – The name of the job template you are creating.priority (
Union[int,float,None]) – 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: 50queue (
Optional[str]) – 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.status_update_interval (
Optional[str]) – 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_600tags (
Optional[Any]) – An array of key-value pairs to apply to this resource. For more information, see Tag .
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
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.
- Parameters:
target (
CfnResource) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str) –value (
Any) –
- See:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill 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.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
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).- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
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.- Parameters:
attribute_name (
str) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str) –- See:
- Return type:
Any
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)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::MediaConvert::JobTemplate'
- acceleration_settings
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 .
- attr_arn
The Amazon Resource Name (ARN) of the job template, such as
arn:aws:mediaconvert:us-west-2:123456789012.- CloudformationAttribute:
Arn
- attr_name
The name of the job template, such as
Streaming stack DASH.- CloudformationAttribute:
Name
- category
Optional.
A category for the job template you are creating
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- description
Optional.
A description of the job template you are creating.
- hop_destinations
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 .
- logical_id
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).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of the job template you are creating.
- node
The construct tree node associated with this construct.
- priority
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
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.
- ref
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 }).
- settings_json
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
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- status_update_interval
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 Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any) –- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any) –- Return type:
bool
AccelerationSettingsProperty
- class CfnJobTemplate.AccelerationSettingsProperty(*, mode)
Bases:
objectAccelerated 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 .
- Parameters:
mode (
str) – Specify the conditions when the service will run your job with accelerated transcoding.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_mediaconvert as mediaconvert acceleration_settings_property = mediaconvert.CfnJobTemplate.AccelerationSettingsProperty( mode="mode" )
Attributes
- mode
Specify the conditions when the service will run your job with accelerated transcoding.
HopDestinationProperty
- class CfnJobTemplate.HopDestinationProperty(*, priority=None, queue=None, wait_minutes=None)
Bases:
objectOptional.
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 .
- Parameters:
priority (
Union[int,float,None]) – Optional. When you set up a job to use queue hopping, you can specify a different relative priority for the job in the destination queue. If you don’t specify, the relative priority will remain the same as in the previous queue.queue (
Optional[str]) – Optional unless the job is submitted on the default queue. When you set up a job to use queue hopping, you can specify a destination queue. This queue cannot be the original queue to which the job is submitted. If the original queue isn’t the default queue and you don’t specify the destination queue, the job will move to the default queue.wait_minutes (
Union[int,float,None]) – Required for setting up a job to use queue hopping. Minimum wait time in minutes until the job can hop to the destination queue. Valid range is 1 to 4320 minutes, inclusive.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_mediaconvert as mediaconvert hop_destination_property = mediaconvert.CfnJobTemplate.HopDestinationProperty( priority=123, queue="queue", wait_minutes=123 )
Attributes
- priority
Optional.
When you set up a job to use queue hopping, you can specify a different relative priority for the job in the destination queue. If you don’t specify, the relative priority will remain the same as in the previous queue.
- queue
Optional unless the job is submitted on the default queue.
When you set up a job to use queue hopping, you can specify a destination queue. This queue cannot be the original queue to which the job is submitted. If the original queue isn’t the default queue and you don’t specify the destination queue, the job will move to the default queue.
- wait_minutes
Required for setting up a job to use queue hopping.
Minimum wait time in minutes until the job can hop to the destination queue. Valid range is 1 to 4320 minutes, inclusive.