CfnJobTemplatePropsMixin
- class aws_cdk.mixins_preview.aws_mediaconvert.mixins.CfnJobTemplatePropsMixin(props, *, strategy=None)
Bases:
MixinThe 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 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 ** .
- See:
- CloudformationResource:
AWS::MediaConvert::JobTemplate
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview import mixins from aws_cdk.mixins_preview.aws_mediaconvert import mixins as mediaconvert_mixins # settings_json: Any # tags: Any cfn_job_template_props_mixin = mediaconvert_mixins.CfnJobTemplatePropsMixin(mediaconvert_mixins.CfnJobTemplateMixinProps( acceleration_settings=mediaconvert_mixins.CfnJobTemplatePropsMixin.AccelerationSettingsProperty( mode="mode" ), category="category", description="description", hop_destinations=[mediaconvert_mixins.CfnJobTemplatePropsMixin.HopDestinationProperty( priority=123, queue="queue", wait_minutes=123 )], name="name", priority=123, queue="queue", settings_json=settings_json, status_update_interval="statusUpdateInterval", tags=tags ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::MediaConvert::JobTemplate.- Parameters:
props (
Union[CfnJobTemplateMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['accelerationSettings', 'category', 'description', 'hopDestinations', 'name', 'priority', 'queue', 'settingsJson', 'statusUpdateInterval', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
AccelerationSettingsProperty
- class CfnJobTemplatePropsMixin.AccelerationSettingsProperty(*, mode=None)
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 (
Optional[str]) – Specify the conditions when the service will run your job with accelerated transcoding.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_mediaconvert import mixins as mediaconvert_mixins acceleration_settings_property = mediaconvert_mixins.CfnJobTemplatePropsMixin.AccelerationSettingsProperty( mode="mode" )
Attributes
- mode
Specify the conditions when the service will run your job with accelerated transcoding.
HopDestinationProperty
- class CfnJobTemplatePropsMixin.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.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_mediaconvert import mixins as mediaconvert_mixins hop_destination_property = mediaconvert_mixins.CfnJobTemplatePropsMixin.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.